summaryrefslogtreecommitdiff
path: root/doc/user/bib.skb
diff options
context:
space:
mode:
authorLudovic Courtès2008-01-22 19:17:15 +0100
committerLudovic Courtès2008-01-22 19:17:15 +0100
commit1c48e83c54179144b82f8e1323101baf0c6b1a8d (patch)
tree94a5ceb3a8d140111890c0b1cf290b35184c86b9 /doc/user/bib.skb
parentffd3ed37343917e87d27acb38a377686e866d741 (diff)
downloadskribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.tar.gz
skribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.tar.lz
skribilo-1c48e83c54179144b82f8e1323101baf0c6b1a8d.zip
doc: Document all the `*xxx-path*' parameters.
* doc/modules/skribilo/documentation/manual.scm (srfi-ref): New. * doc/user/bib.skb: Add `*bib-path*'. * doc/user/image.skb: Add `*image-path*'. * doc/user/lib.skb: Mention `-I' command-line option for `*document-path*'. * doc/user/prgm.skb: Add `*source-path*'. * doc/user/skribec.skb: Add `:ident' for chapter.
Diffstat (limited to 'doc/user/bib.skb')
-rw-r--r--doc/user/bib.skb16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/user/bib.skb b/doc/user/bib.skb
index 4ede5fd..f5dde61 100644
--- a/doc/user/bib.skb
+++ b/doc/user/bib.skb
@@ -1,7 +1,7 @@
;;; bib.skb -- The Skribilo bibliography.
;;;
+;;; Copyright 2007, 2008 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2001, 2002, 2003, 2004 Manuel Serrano
-;;; Copyright 2007 Ludovic Courtès <ludo@gnu.org>
;;;
;;;
;;; This program is free software; you can redistribute it and/or modify
@@ -73,8 +73,7 @@ bibliography-table:])
:common-args '()
:source #f
:def '(define-markup (*bib-table*) ...))
- (p [Technically, ,(code "*bib-table*") is actually an ,(ref :text
-[SRFI-39] :url "http://srfi.schemers.org/srfi-39/srfi-39.html")
+ (p [Technically, ,(code "*bib-table*") is actually an ,(srfi-ref 39)
parameter object, so it can be queried and modified like any other
parameter object.])
@@ -110,7 +109,7 @@ the ,(code "bibliography") Skribe function call before the call to the
(:bib-table ,[The ,(ref :mark "make-bib-table" :text "table")
where entry is searched.])
(#!rest entry... ,[If ,(param 'entry) is a string, it denotes
- a file containing the entry (see ,(ref :mark "skribe-bib-path"
+ a file containing the entry (see ,(ref :mark "*bib-path*"
:text "bibliograph path")). Otherwise, it is a list described
by the ,(ref :subsection "Bibliography Syntax" :text "syntax")
below.]))
@@ -118,6 +117,15 @@ the ,(code "bibliography") Skribe function call before the call to the
:force-engines *api-engines*
:common-args '())
+(mark "*bib-path*")
+(p [Files passed as an argument to ,(markup-ref "bibliography") are
+searched in the current ,(emph [bibliography path]), which is defined by
+the ,(tt [*bib-path*]) ,(srfi-ref 39) parameter. This parameter
+contains a list of directories and its value can be obtained using
+,(code [(*bib-path*)]). Its value can be altered using the ,(tt
+[-B]) command-line option of the ,(tt [skribilo]) compiler (see ,(numref
+:text [Chapter] :ident "compiler") for details).])
+
(p [The ,(param :command) option can be used to import foreign bibliography.
The following example, shows how to directly use a Bibtex bibliography
using the ,(ref :section "Skribebibtex") translator.])