From: David G. <go...@us...> - 2002-10-10 03:00:53
|
Aahz wrote: >>> Let's suppose I've got a figure, and I want to refer to it (e.g. "See >>> figure 3.11"), how do I do that? >> >> I don't know. Currently, figures don't have any attribute which can be >> referenced. Perhaps a "name" option on figures? For example:: >> >> .. figure:: image.png >> :name: image's name I've thought some more about this (full details soon to appear in the spec/notes.txt file), and I think the best way to name an object is the way we've always named targets:: .. _figure name: .. figure:: image.png This applies equally well to tables. >> How to refer to a figure though? Perhaps something like this:: >> >> See :figure:`image's name`. I also toyed with the idea of parameterized substitutions:: See |figure (figure name)|, on |page (figure name)|. .. |figure (name)| figure-ref:: (name) .. |page (name)| page-ref:: (name) The result would be:: See figure 3.11 on page 157. But this would require substitution directives to be processed at reference-time, not at definition-time as they are now. Or, the directives could just leave ``pending`` elements behind, and the transforms could do the work. How to pass the data through? Too complicated. The original interpreted text approach is better:: See :figure:`figure name` on :page:`figure name`. The "figure" and "page" roles could generate some boilerplate text. The position of the role (prefix or suffix) could also be utilized. >>> I'm probably going to create some kind of ToC directive that goes >>> in an include file so I can create cross-chapter references >>> easily. >> >> I don't follow. ... > What I'm thinking more of (at least for starters) is an > extremely simple list of references to reST documents. Can you elaborate with details of the file's contents, and ideas of how it would work? I'd like to understand what you're proposing (and I don't have a clue now). -- David Goodger <go...@us...> Open-source projects: - Python Docutils: http://docutils.sourceforge.net/ (includes reStructuredText: http://docutils.sf.net/rst.html) - The Go Tools Project: http://gotools.sourceforge.net/ |