jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixes repeated index terms leading to same HTML anchor.

Browse source 
Instead of a hash for the rst node tree (which will always be the same)
a simple counter table is used.
This commit is contained in:
Grzegorz Adam Hankiewicz 2014-04-21 19:49:10 +02:00
commit 831e12d8f8
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/packages/docutils/rstgen.nim
View file

@ -57,6 +57,9 @@ type
currentSection: string ## \ currentSection: string ## \
## Stores the empty string or the last headline/overline found in the rst ## Stores the empty string or the last headline/overline found in the rst
## document, so it can be used as a prettier name for term index generation. ## document, so it can be used as a prettier name for term index generation.
seenIndexTerms: TTable[string, int] ## \
## Keeps count of same text index terms to generate different identifiers
## for hyperlinks. See renderIndexTerm proc for details.
PDoc = var TRstGenerator ## Alias to type less. PDoc = var TRstGenerator ## Alias to type less.
@ -112,6 +115,7 @@ proc initRstGenerator*(g: var TRstGenerator, target: TOutputTarget,
g.options = options g.options = options
g.findFile = findFile g.findFile = findFile
g.currentSection = "" g.currentSection = ""
g.seenIndexTerms = initTable[string, int]()
g.msgHandler = msgHandler g.msgHandler = msgHandler
let s = config["split.item.toc"] let s = config["split.item.toc"]
@ -295,8 +299,20 @@ proc hash(n: PRstNode): int =
result = result !& hash(n.sons[i]) result = result !& hash(n.sons[i])
result = !$result result = !$result
proc renderIndexTerm(d: PDoc, n: PRstNode, result: var string) = proc renderIndexTerm*(d: PDoc, n: PRstNode, result: var string) =
let id = rstnodeToRefname(n) & '_' & $abs(hash(n)) ## Renders the string decorated within \`foobar\`\:idx\: markers.
##
## Additionally adds the encosed text to the index as a term. Since we are
## interested in different instances of the same term to have different
## entries, a table is used to keep track of the amount of times a term has
## previously appeared to give a different identifier value for each.
let refname = n.rstnodeToRefname
if d.seenIndexTerms.hasKey(refname):
d.seenIndexTerms[refname] = d.seenIndexTerms[refname] + 1
else:
d.seenIndexTerms[refname] = 1
let id = refname & '_' & $d.seenIndexTerms[refname]
var term = "" var term = ""
renderAux(d, n, term) renderAux(d, n, term)
setIndexTerm(d, id, term, d.currentSection) setIndexTerm(d, id, term, d.currentSection)