Re^3: Writeup Formatting in my mind

Replies are listed 'Best First'.
Re^4: Writeup Formatting in my mind by dimar (Curate) on Feb 15, 2005 at 15:47 UTC
Problem: How do I specify special text formatting instructions when I post on perlmonks.org? Solution: Use the info found on Writeup Formatting Tips which describes the special tags used on perlmonks. Discussion: When posting on perlmonks, most of your special formatting can be done using simple HTML, and a couple tags that are not specified in formal HTML. They are called "readmore" tags, and "code" tags. If you try to use a different syntax to specify formatting instructions, (such as POD, or Wiki) you might not get what you expected. Issue1: POD and Wiki is my favorite syntax in the world! Can I use that on perlmonks also? Response1: If you want to illustrate what POD and Wiki syntax looks like (for instructional purposes, asking questions, so forth) then you should write the POD syntax as you normally would, making sure to enclose it with "code" tags. For example: `=head1 Hello World, this is POD. This looks different because I wrapped this text in "code" tags so it would look nice on perlmonks. =cut` [download] If you want to use POD and Wiki syntax to change the formatting of text (for example to make a word display in 'italics') that will not work on perlmonks (not yet anyway). One reason why it won't work is (probably) because it is simpler to write posts that way, and simpler to write the code that runs the perlmonks website. If you are excited about POD and Wiki syntax formatting, that's great, but just remember, there are many many syntax formats out there in the world, and no single one of them works or is understood everywhere. It's sort of like the way human languages work. Stay flexible, keep learning, help others learn, and grow to your fullest potential. TMTOWTDI.	[reply] [d/l]

Replies are listed 'Best First'.

Re^4: Writeup Formatting in my mind
by dimar (Curate) on Feb 15, 2005 at 15:47 UTC

Problem:
How do I specify special text formatting instructions when I post on perlmonks.org?

Solution:
Use the info found on Writeup Formatting Tips which describes the special tags used on perlmonks.

Discussion:
When posting on perlmonks, most of your special formatting can be done using simple HTML, and a couple tags that are not specified in formal HTML. They are called "readmore" tags, and "code" tags. If you try to use a *different* syntax to specify formatting instructions, (such as POD, or Wiki) you might not get what you expected.

Issue1:
POD and Wiki is my favorite syntax in the world! Can I use that on perlmonks also?

Response1:
If you want to *illustrate* what POD and Wiki syntax looks like (for instructional purposes, asking questions, so forth) then you should write the POD syntax as you normally would, making sure to enclose it with "code" tags. For example:

=head1
Hello World, this is POD. This looks different
because I wrapped this text in "code" tags so
it would look nice on perlmonks.
=cut
[download]

If you want to *use* POD and Wiki syntax to change the formatting of text (for example to make a word display in 'italics') that will not work on perlmonks (not yet anyway). One reason *why* it won't work is (probably) because it is simpler to write posts that way, and simpler to write the code that runs the perlmonks website.

If you are excited about POD and Wiki syntax formatting, that's great, but just remember, there are many many syntax formats out there in the world, and no single one of them works or is understood everywhere. It's sort of like the way human languages work. Stay flexible, keep learning, help others learn, and grow to your fullest potential. TMTOWTDI.

[reply]
[d/l]