Wise developers,

this is not to ask you to change the way special characters are escaped in PM.

Today I really had hard times finding how I could insert a square bracket in my post, because this is not written in Writeup Formatting Tips where I would expect it. I even tried to supersearch! My lack of quickness is notoriuous, but...

I would humbly suggest to do the following:

Something like: 
Special characters quick reference: "<" is "&lt;", "[" is "&#91;"; ...

[download]

Flavio (perl -e 'print(scalar(reverse("\nti.xittelop\@oivalf")))')

Don't fool yourself.

Replies are listed 'Best First'.
Re: Escaping special characters in PM
by davidrw (Prior) on May 14, 2005 at 13:37 UTC
    I knew I had seen the square bracket use noted somewhere... On your Edit User Settings page, under the "Custom Node Title Definition" section, it says:
    Available tokens are %T (title), %D (create date), %N (node id), and %
+S (section; e.g. SOPW, Q&A, but only for root nodes). Don't use [ nor
+ ]; use &#91; and &#93; instead.

    [download]
    But that's obviously specific to that user setting, and not easy to find ...

    An alternative place to adding a note in [id://Writeup Formatting Tips] would be to add it to Perl Monks Approved HTML tags to explicitly state the the HTML & codes work.

    Update: You're right--i think the first spot is better, too. I meant "alternative" more as "possible" to just give the developers another spot that it could be useful in case they didn't like the first spot for some reason.
[reply]
[d/l]
      Dooh! That's where I read them!

      I don't entirely agree about your alternative suggestion, I would really like to see a brief list of the most useful codes instead of a note that they do work (which I could already know) without seeing which they are.

      Thanks to eibwen's suggestion I've added it to my Free Nodelet, so I'll be able to find it in the future. Notwithstanding, I still think that it would be useful for most Monks to find it at the end of the editing page, near the list of approved tags.

      Flavio (perl -e 'print(scalar(reverse("\nti.xittelop\@oivalf")))')

      Don't fool yourself.
[reply]
Re: Escaping special characters in PM
by ysth (Canon) on May 15, 2005 at 13:15 UTC
    • Add it in the notes at the bottom of the pages, near to where all approved tags are listed
    Do you mean on the preview page? (Update: if so, done.)
    Done.
[reply]
      I meant exactly where you put it, thank you. I couldn't call them preview pages, because the same note is also at the bottom of the various "home pages" for the different sections, where you can add a post.

      BTW, this footer would be useful in the "Comment on" page as well, before the first preview, and in general in all pages that let you edit something (like the pages showing a node made by "you", where you can update the post) - the only line that would not make sense there would be the first, referring to Where should I post X? :)

      Flavio (perl -e 'print(scalar(reverse("\nti.xittelop\@oivalf")))')

      Don't fool yourself.
[reply]

Back to Perl Monks Discussion