in reply to Writeup Formatting in my mind

Another point to consider, since this site deals with programming, it is best to keep the formatting rules to a functional minimum. That's because you don't want to accidentally preclude someone from *mentioning* how to write POD, or Wiki formatting because their input was mistakenly interpreted as *using* POD, or Wiki formatting.

Replies are listed 'Best First'.
Re^2: Writeup Formatting in my mind
by edan (Curate) on Feb 15, 2005 at 13:49 UTC

    But that's what we have <code> tags for ...

    --
    edan

[reply]
[d/l]

      Sorry, I do not know, what you mean. The problem I actually have is (to be more concise), that I always write I<italic>!

      Since I am pretty excited about Wiki format (and used to POD), I just wanted to find out about your thoughts on this topic.

[reply]

        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]

In Section Perl Monks Discussion