From: Stefan M. <sm...@oe...> - 2011-05-03 18:51:29
|
Hi! Recently I'm (ab)using citation definitions and citation references for the following purpose: In a document I am using a citation definition defining an anchor and reference this anchor from various places by using citation references. What I want in the final (HTML) document is a list of backlinks to the referencing places at the anchor definition so it's easy for the reader to jump to all the referencing places. This works like this:: .. [StakeholderX] This is interesting for stakeholder X. blah blah blah. This is where [StakeholderX]_ comes into play. Blah blah Blah At this point [StakeholderX]_ has to decide blah blah The drawback of this solution is that I need to use the citation syntax involving brackets. For this purpose these brackets are not desirable of course. Also the citation tags do not allow blanks. Thus I'm thinking about a better solution. What I want is a sort of generalized backlink feature for a target. Here are some requirements which come to mind: (1) Since the backlinks need to be rendered somewhere in the text an optimal solution would be inline (2) The definition of the target should be the only place where it is decided whether there are backlinks or not Requirement (2) implies that a reference to such a target should be the same as to any other target. I.e. use `normal link syntax`_. Requirement (1) implies that an anchor must be defined inline similar to _`normal anchors`. One solution would be to define a role defining the anchor like this:: :backlinking-anchor:`Stakeholder X` is referenced in many places in this document. blah blah blah. This is where `Stakeholder X`_ comes into play. Blah blah Blah At this point `Stakeholder X`_ has to decide blah blah This would solve my problem and would not need new syntax (which would be overkill IMHO). What do you think? Grüße Stefan |
From: Guenter M. <mi...@us...> - 2011-05-05 06:51:16
|
On 2011-05-03, Stefan Merten wrote: > Recently I'm (ab)using citation definitions and citation references > for the following purpose: In a document I am using a citation > definition defining an anchor and reference this anchor from various > places by using citation references. What I want in the final (HTML) > document is a list of backlinks to the referencing places at the > anchor definition so it's easy for the reader to jump to all the > referencing places. This works like this:: > .. [StakeholderX] This is interesting for stakeholder X. > blah blah blah. This is where [StakeholderX]_ comes into play. Blah > blah > Blah At this point [StakeholderX]_ has to decide blah blah > The drawback of this solution is that I need to use the citation > syntax involving brackets. For this purpose these brackets are not > desirable of course. The html_strict writer could be amended to place the brackets via CSS so that an improved hack would include styling the citations-output with a style sheet. > Also the citation tags do not allow blanks. Thus > I'm thinking about a better solution. > What I want is a sort of generalized backlink feature for a target. > Here are some requirements which come to mind: > (1) Since the backlinks need to be rendered somewhere in the text an > optimal solution would be inline > (2) The definition of the target should be the only place where it is > decided whether there are backlinks or not > Requirement (2) implies that a reference to such a target should be > the same as to any other target. I.e. use `normal link syntax`_. > Requirement (1) implies that an anchor must be defined inline similar > to _`normal anchors`. > One solution would be to define a role defining the anchor like this:: > :backlinking-anchor:`Stakeholder X` is referenced in many places in > this document. > blah blah blah. This is where `Stakeholder X`_ comes into play. Blah > blah > Blah At this point `Stakeholder X`_ has to decide blah blah > This would solve my problem and would not need new syntax (which would > be overkill IMHO). > What do you think? Sounds like a bit of work but "doable". As I do not see widespread use for this feature, maybe you can implement this as an add-on in the sandbox + announce in the Docutils link list (links.txt)? Günter |