Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl Monk, Perl Meditation
 
PerlMonks  

Re: RFC: Monastery Markup Introduction

by blokhead (Monsignor)
on Mar 07, 2008 at 20:09 UTC ( #672880=note: print w/ replies, xml ) Need Help??


in reply to RFC: Monastery Markup Introduction

When I saw Need examples for PerlMonks HTML Tags, I pictured something much more visual and "cheat sheet"-like:

PM Markup:Result:
paragraphs / line breaks
<p>first paragraph</p>
<p>second paragraph</p>

first paragraph

second paragraph

link to nodes by name
Have you tried [Super Search]?
Have you tried Super Search?
Thanks for your help, [tye]
Thanks for your help, tye
Thanks for nothing, [tye|wiseguy]
Thanks for nothing, wiseguy
link to nodes by ID
Please consult [id://3989]
Please consult Super Search
other kinds of links

(more info)

Check out [pad://NodeReaper]
Check out NodeReaper's scratchpad
Did you try [http://google.com|this]?
Did you try this?
Did you check [doc://perlfaq]?
Did you check perlfaq?
including code in text
The result is in <c>$array[0]</c>
The result is in $array[0]
The code should read:
<c>
use strict;
use warnings;

my @array = ("Hello world\n");
if (@ARGV) {
    print $array[0];
}
</c>
The code should read:
use strict; use warnings; my @array = ("Hello world\n"); if (@ARGV) { print $array[0]; }
text/font formatting
This will be <b>bold</b>
This will be bold
This will be <i>italic</i>
This will be italic
This will be <tt>fixed width</tt>
This will be fixed width
quoting / indenting
A wise monk once said:
<blockquote>
"Indenting is good"
</blockquote>
.. and I agree
A wise monk once said:
"Indenting is good"
.. and I agree
lists
My favorite flavors are:
<ul>
<li>vanilla</li>
<li>chocolate</li>
</ul>
My favorite flavors are:
  • vanilla
  • chocolate
How to make toast:
<ol>
<li>insert bread</li>
<li>press button</li>
</ol>
How to make toast:
  1. insert bread
  2. press button

I adapted the tags you decided to include in your introduction.

This node is intended as a 60 second introduction to markup used here.
If so, then it is much too long IMHO.

Update: missing </pre> tags inserted, according to GrandFather's suggestion.

Update 2: demonstrated whitespace preservation of <c> tags. Thanks to kyle for that suggestion.

blokhead


Comment on Re: RFC: Monastery Markup Introduction
Select or Download Code
Re^2: RFC: Monastery Markup Introduction
by GrandFather (Cardinal) on Mar 07, 2008 at 20:57 UTC

    I recommend, as ww has suggested, that you:

    consider turning on (checking) the "enforce" and setting "Reporting Level" and its "Preview" to the max values

    then review your node. ;)


    Perl is environmentally friendly - it saves trees
Re^2: RFC: Monastery Markup Introduction
by Gavin (Canon) on Mar 07, 2008 at 22:45 UTC
    Magic blokhead ++ Just the job, you must have been reading my mind or vice versa.
Re^2: RFC: Monastery Markup Introduction
by kyle (Abbot) on Mar 08, 2008 at 04:42 UTC

    I'd recommend the code example include some indentation so that it's clear <code> behaves like <pre> in this respect.

    use strict; use warnings; if ( ! @ARGV ) { die "not enough arguments\n"; }

    I'd hate to see <blockquote> in the middle of somebody's code.

Re^2: RFC: Monastery Markup Introduction
by Gavin (Canon) on Mar 08, 2008 at 11:57 UTC

    The only addition that I can think of would be an example to an external link for example.

    <a href=" http://nbpfaus.net/~pfau/cbhistory.cgi?site=PM "> CB History </a>

    Which would display

    CB History
Re^2: RFC: Monastery Markup Introduction
by Argel (Prior) on Mar 10, 2008 at 18:55 UTC
      ++

    Very, very nice! I really think this is the way to go! If we want users to actually read something then it needs to be concise and easily accessible. Most people have used references and one page "cheat sheets" before so I think this format will feel very natural and likely see much more use.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://672880]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others wandering the Monastery: (6)
As of 2014-08-30 12:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (293 votes), past polls