Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

In the table of contents, the entries are listed as "Basics: Para & Code markup", "Additional Markup (Overview+Examples)", and the like. In the body of the document, those same are "<h3>Chapter 1</h3>" and "<h3>Chapter 2</h3>". As LanX put it, " why not simply <h3>Chapter 1 - Basics: Para & Code markup</h3> for both?".

It had been a while since I'd read the original Markup in the Monastery node, and I had assumed that something had been changed, because I didn't remember those sections being called "Chapter 1" and "Chapter 2" in the original... but apparently I was wrong. Sorry.

I guess now my suggestion (to echo LanX), would be to use the same meaningful names that you manually chose for the TOC as the actual headers in the flow of the document. (Clicking on "Basics: Para & Code markup" and arriving at "Chapter 1" is confusing to me, and would likely confuse someone new to the document as well.)


In reply to Re^3: TOC draft sample by pryrt
in thread TOC draft sample by ww

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others perusing the Monastery: (3)
    As of 2020-03-30 00:11 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      To "Disagree to disagree" means to:









      Results (171 votes). Check out past polls.

      Notices?