From c4f69b5f8c3fbbd42f745b8abdeed4a8436fde11 Mon Sep 17 00:00:00 2001
From: Ludovic Court`es
Date: Fri, 29 Jun 2007 11:33:36 +0000
Subject: Updated documentation of `ref'.
git-archimport-id: lcourtes@laas.fr--2006-libre/skribilo--devo--1.2--patch-81
---
doc/user/links.skb | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/doc/user/links.skb b/doc/user/links.skb
index c6e37a0..0bc19f7 100644
--- a/doc/user/links.skb
+++ b/doc/user/links.skb
@@ -99,6 +99,14 @@ section, to bibliographic entries, to source code line number, etc.])
(:bib-table ,[The
,(ref :chapter "Bibliographies" :text "bibliography") where
searching the entry.])
+ (:sort-bib-refs ,[In case where multiple bibliography
+ entries are referenced, as in ,(code [(ref :bib
+ '("smith81:disintegration" "corgan07:zeitgeist"))]),
+ this should be a two-argument procedure suitable
+ for sorting. The default procedure sorts references
+ by number, when ,(markup-ref "the-bibliography") uses
+ the ,(code [number]) labeling style. If it is
+ ,(code [#f]), then references will not be sorted.])
(:line [A reference to a ,(ref :mark "prog" :text "program")
line number.])
(:skribe [The name of a
@@ -109,7 +117,7 @@ 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 numref))
+ :see-also '(index numref the-bibliography))
(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
--
cgit v1.2.3