Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine

comment on

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

G'day Lanx,

The idea of being able to use fragment identifiers is a good one.

Some pages have them but they're not easy to find. For instance, I can link to the section of "What shortcuts can I use for linking to other information?" which explains how to use fragment identifiers with this type of markup: [href://?node_id=43037#general|General-Purpose Linking Shortcuts] (which renders as General-Purpose Linking Shortcuts); however, you need to know that the identifiers exist on that particular page and then you have to find them. I generally use the "Inspect Element" browser tool menu option for this; another (less than optimal) method would be to search the page's source HTML code.

Many other pages don't have such identifiers, so a first step would be to add them.

A TOC would one way to handle this: I can certainly see benefits to doing this. When I've found what I'm looking for in a page, having an indication of the identifier at that point would be better than having to scroll back to the top to see what the TOC links to. I've seen this type of thing done with unobtrusive link text consisting of a single symbol character: § and seem to be used quite a lot; I've seen others, many with various types of arrow symbols; I don't really have a preference.

I also think the syntax for such links needs to be made more obvious — it's virtually a hidden feature at present. As I'm writing this, I see a link for "What shortcuts can I use for linking to other information?" almost at the bottom of the page. Following that link, I then need to scroll down five screenfuls (on my 27' monitor) to find the information. Searching that page for "fragment" or "identifier" finds no matches; searching for "href:" finds it but, if you knew to search for that, you probably didn't need to (i.e. you already know the syntax).

— Ken

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

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?

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

    How do I use this? | Other CB clients
    Other Users?
    Others about the Monastery: (5)
    As of 2020-11-27 23:32 GMT
    Find Nodes?
      Voting Booth?

      No recent polls found