develooper Front page | perl.perl5.porters | Postings from January 2019

[perl #133805] Named subsections in perlref

Thread Previous
From:
Dan Book
Date:
January 29, 2019 02:24
Subject:
[perl #133805] Named subsections in perlref
Message ID:
rt-4.0.24-7677-1548728648-1356.133805-75-0@perl.org
# New Ticket Created by  Dan Book 
# Please include the string:  [perl #133805]
# in the subject line of all future correspondence about this issue. 
# <URL: https://rt.perl.org/Ticket/Display.html?id=133805 >


The perlref documentation contains two numbered lists, which are really
sequences of documentation on distinct subjects or components, and so it is
reasonable to look for or link to these subsections directly. To facilitate
this, the to-be-attached patch will change the ordered lists into named
headings, with two effects as viewed on https://perldoc.pl/perlref and
https://metacpan.org/pod/perlref.

1. Changing the subsections to proper headings adds them to the table of
contents, making them more discoverable, and the sections more easily
linkable by a recognizable name. The table of contents is quite small
currently so I don't believe this will cause undue clutter.

2. The second list (under heading "Using References") is not currently
linkable at all, as it gets rendered differently, presumably out of the
requirement of the following set of paragraphs that are not part of the
list. As part of this patch, the following paragraphs are placed under a
new "Miscellanous Usage" heading.

-Dan

(Perl)


Thread Previous


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About