Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

comment on

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

TOC is a good idea on this one; since I wrote the original, I edit, 7 Nov 17 will try to free up time, soonest, to add one. offer TOC draft sample for comment and review.

FOR COMMENT: seems like a TOC with both a few keywords for each topic AND the markup needed would be appropriate... but a big PITA.

Update, 7 Nov 17 It was! The PITA is finding an appropriate, very brief description for the various parts of the TOC (and, in this case, deciding which elements of the main text to include to best serve users!

FWIW: Others have written technical approaches, using clever code to identify elements that may need to be included in a TOC. I went "manual" to deal with the issue I perceive (at least in the case of Markup in the Monastery; namely, that the so-called "Chapter...." headings are not, themselves, informative for someone seeking (for example) to know how to create a list. Also, when I created "Markup" originally, the various <Hn> tags were for formatting only, without due regard to nesting (I don't know of any commonly-used browser, even today, that cares) or syntactical relevance. Call me a dinosaur, but I still don't worry about that: even today, itelligibility of content trumps sytactical correctness.

Quis custodiet ipsos custodes. Juvenal, Satires


In reply to Re: TOCs and deeplinks for our house rules by ww
in thread TOCs and deeplinks for our house rules by LanX

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 chanting in the Monastery: (6)
    As of 2019-11-19 19:02 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      Strict and warnings: which comes first?



      Results (95 votes). Check out past polls.

      Notices?