diff options
| author | Ludovic Court`es | 2006-11-24 12:56:27 +0000 |
|---|---|---|
| committer | Ludovic Court`es | 2006-11-24 12:56:27 +0000 |
| commit | 3e46caf3e034552854ff6829ca2bf4e0a46e0089 (patch) | |
| tree | 31e7b118e62646271febd04a078f6e90ecda0170 /doc | |
| parent | 4c3a84d4fd923cefc663d314d5659253101b70f9 (diff) | |
| download | skribilo-3e46caf3e034552854ff6829ca2bf4e0a46e0089.tar.gz skribilo-3e46caf3e034552854ff6829ca2bf4e0a46e0089.tar.lz skribilo-3e46caf3e034552854ff6829ca2bf4e0a46e0089.zip | |
doc: Documented `numref'.
* doc/user/links.skb (Reference): Added identifier `refs'.
[ref](page): Explain that this option is hardcopy-specific.
[numref]: New.
* doc/user/src/links1.skb: Show `numref' usage.
git-archimport-id: lcourtes@laas.fr--2005-libre/skribilo--devo--1.2--patch-78
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/user/links.skb | 24 | ||||
| -rw-r--r-- | doc/user/src/links1.skb | 4 |
2 files changed, 23 insertions, 5 deletions
diff --git a/doc/user/links.skb b/doc/user/links.skb index ae7301c..c6e37a0 100644 --- a/doc/user/links.skb +++ b/doc/user/links.skb @@ -71,9 +71,9 @@ automatically sets a mark whose value is the legend of the figure.])) ;*---------------------------------------------------------------------*/ ;* ref ... @label ref@ */ ;*---------------------------------------------------------------------*/ -(section :title "Reference" +(section :title "Reference" :ident "refs" -(p [Skribe proposes only one single function for all the references. +(p [Skribilo proposes a single function that can be used for most references. This same ,(code "ref") function is used for introducing references to section, to bibliographic entries, to source code line number, etc.]) @@ -92,7 +92,8 @@ section, to bibliographic entries, to source code line number, etc.]) (:section [The title of a ,(markup-ref "section").]) (:subsection [The title of a ,(markup-ref "subsection").]) (:subsubsection [The title of a ,(markup-ref "subsubsection").]) - (:page [A boolean enabling/disabling page reference.]) + (:page [A boolean enabling/disabling page reference (for + hard copies as produced by the Lout and LaTeX engines).]) (:bib ,[A name or a list of names of ,(ref :chapter "Bibliographies" :text "bibliographic") entry.]) (:bib-table ,[The @@ -108,8 +109,21 @@ section, to bibliographic entries, to source code line number, etc.]) a ,(tt "mark") located in the Skribe document described by the ,(var "file") ,(sc "sui").])) :force-args '(:url :bib :line :skribe) - :see-also '(index)) - + :see-also '(index numref)) + +(p [Sometimes, it is useful to produce phrases that refer a section by +its number, as in ``See Section 2.3''. This is especially useful on +printed documents, as produced by the Lout and LaTeX engines. The +,(code "numref") markup is provided to that end:]) + +(doc-markup 'numref + `((:text [Text preceding the reference number.]) + (:ident [The identifier of the node (a chapter, section, + subsection, etc.) being referenced.]) + (:page [A boolean enabling/disabling page reference (for + hard copies as produced by the Lout and LaTeX engines).]) + (:separator [The separator between numbers.])) + :see-also '(ref)) (example-produce (example :legend "Some references" (prgm :file "src/links1.skb")) diff --git a/doc/user/src/links1.skb b/doc/user/src/links1.skb index e0b393b..bfe6f86 100644 --- a/doc/user/src/links1.skb +++ b/doc/user/src/links1.skb @@ -11,6 +11,10 @@ That other one points to a well known ,(code ":text"): ,(ref :url "http://slashdot.org/"). ,(linebreak) +And one can also refer to sections by number, as in ``see ,(numref :text +[Wonderful Section] :ident "refs")''. + +,(linebreak) With more complex tricks that are explained in Section ,(ref :section "Resolve"), it is also possible use, for the text of the reference, a container number such as chapter: |