summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLudovic Courtès2012-05-23 23:39:09 +0200
committerLudovic Courtès2012-05-23 23:39:09 +0200
commit1b2f2d42bd9151453f2b10a34aff3fbfc28d5223 (patch)
treec94f41257e037a7515da699d1253c923da87706e
parent870a700f68208de3e71a4eb1abae67828f290399 (diff)
downloadskribilo-1b2f2d42bd9151453f2b10a34aff3fbfc28d5223.tar.gz
skribilo-1b2f2d42bd9151453f2b10a34aff3fbfc28d5223.tar.lz
skribilo-1b2f2d42bd9151453f2b10a34aff3fbfc28d5223.zip
doc: Give engine sections an ident and remove the mark with that ident.
* doc/modules/skribilo/documentation/api.scm (doc-markup): Refer to engines by `ident' instead of by `mark'. * doc/user/compiler.skb, doc/user/engine.skb, doc/user/links.skb, doc/user/package.skb, doc/user/sectioning.skb: Update references accordingly. * doc/user/contexte.skb, doc/user/htmle.skb, doc/user/infoe.skb, doc/user/latexe.skb, doc/user/loute.skb, doc/user/xmle.skb: Give sections an ident, and remove the mark.
-rw-r--r--doc/modules/skribilo/documentation/api.scm6
-rw-r--r--doc/user/compiler.skb4
-rw-r--r--doc/user/contexte.skb5
-rw-r--r--doc/user/engine.skb2
-rw-r--r--doc/user/htmle.skb5
-rw-r--r--doc/user/infoe.skb5
-rw-r--r--doc/user/latexe.skb3
-rw-r--r--doc/user/links.skb4
-rw-r--r--doc/user/loute.skb6
-rw-r--r--doc/user/package.skb2
-rw-r--r--doc/user/sectioning.skb6
-rw-r--r--doc/user/xmle.skb5
12 files changed, 23 insertions, 30 deletions
diff --git a/doc/modules/skribilo/documentation/api.scm b/doc/modules/skribilo/documentation/api.scm
index 9ac683c..873e03a 100644
--- a/doc/modules/skribilo/documentation/api.scm
+++ b/doc/modules/skribilo/documentation/api.scm
@@ -1,7 +1,7 @@
;;; api.scm -- The style for documenting Scheme APIs.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2005, 2006, 2007, 2008, 2009 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2005, 2006, 2007, 2008, 2009, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
@@ -529,9 +529,9 @@
(else
(list (if sui
(ref :skribe sui
- :mark (string-append s "-engine")
+ :ident (string-append s "-engine")
:text s)
- (ref :mark (string-append s "-engine")
+ (ref :ident (string-append s "-engine")
:text s))
" ")))))
(if (pair? force-engines)
diff --git a/doc/user/compiler.skb b/doc/user/compiler.skb
index 8bb4bbd..e4f14e6 100644
--- a/doc/user/compiler.skb
+++ b/doc/user/compiler.skb
@@ -1,7 +1,7 @@
;;; compiler.skb -- The Skribilo compiler.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2008, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2001, 2002, 2003, 2004 Manuel Serrano
;;;
;;;
@@ -106,7 +106,7 @@ compatible implementation is provided.])
search path (see ,(numref :text [Section] :ident "sui") for details).])
`(#\b "base" ,[Strip ,(tt [base]) (an arbitrary string,
-typically an URL) from all hyperlinks when producing ,(ref :mark
+typically an URL) from all hyperlinks when producing ,(ref :ident
"html-engine" :text [HTML files]).])
`(#\e "expr" ,[Prepend ,(tt [expr]) to the list of expressions
to be evaluated before the input document is processed. ,(tt [expr]) is
diff --git a/doc/user/contexte.skb b/doc/user/contexte.skb
index 5c98f83..1c08688 100644
--- a/doc/user/contexte.skb
+++ b/doc/user/contexte.skb
@@ -1,7 +1,7 @@
;;; context.skb -- Documentation of the ConTeXt engine.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2008, 2012 Ludovic Courtès <ludo@gnu.org>
;;;
;;;
;;; This file is part of Skribilo.
@@ -23,8 +23,7 @@
;*---------------------------------------------------------------------*/
;* Document */
;*---------------------------------------------------------------------*/
-(section :title "ConTeXt Engine" :file #t
- (mark "context-engine")
+(section :title "ConTeXt Engine" :file #t :ident "context-engine"
(index "ConTeXt" :note "Engine")
(p [The ,(tt [context]) engine produces documents for the ,(ref :text
diff --git a/doc/user/engine.skb b/doc/user/engine.skb
index 3db9a55..f59387d 100644
--- a/doc/user/engine.skb
+++ b/doc/user/engine.skb
@@ -35,7 +35,7 @@ specifies the ,(emph [engine]) or ``back-end'' to be used, which is
roughly a set of procedures that translate the input document into the
output format. For instance, passing ,(tt [--target=html]) to the
compiler instructs it to produce an HTML document using the ,(ref :text
-(code "html") :mark "html-engine") engine.])
+(code "html") :ident "html-engine") engine.])
(p [This chapter describes procedures allowing the manipulation of
engines in Skribilo documents or modules (creation, customization,
diff --git a/doc/user/htmle.skb b/doc/user/htmle.skb
index 93b7f0e..3342088 100644
--- a/doc/user/htmle.skb
+++ b/doc/user/htmle.skb
@@ -1,7 +1,7 @@
;;; htmle.skb -- Documentation of the HTML engine.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2008, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
@@ -21,8 +21,7 @@
;;; along with Skribilo. If not, see <http://www.gnu.org/licenses/>.
-(section :title "HTML Engine" :file #t
- (mark "html-engine")
+(section :title "HTML Engine" :file #t :ident "html-engine"
(index "HTML" :note "Engine")
(p [The HTML engine produces---guess what!---HTML output. It can be
diff --git a/doc/user/infoe.skb b/doc/user/infoe.skb
index 713be76..d11e0b6 100644
--- a/doc/user/infoe.skb
+++ b/doc/user/infoe.skb
@@ -1,7 +1,7 @@
;;; info.skb -- Documentation of the Info engine.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2009 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2009, 2012 Ludovic Courtès <ludo@gnu.org>
;;;
;;;
;;; This file is part of Skribilo.
@@ -19,8 +19,7 @@
;;; You should have received a copy of the GNU General Public License
;;; along with Skribilo. If not, see <http://www.gnu.org/licenses/>.
-(section :title "Info Engine" :file #t
- (mark "info-engine")
+(section :title "Info Engine" :file #t :ident "info-engine"
(index "Info" :note "Engine")
(p [The ,(tt [info]) engine produces GNU,(~)Info files for on-line
diff --git a/doc/user/latexe.skb b/doc/user/latexe.skb
index 4be0418..142731b 100644
--- a/doc/user/latexe.skb
+++ b/doc/user/latexe.skb
@@ -24,8 +24,7 @@
;*---------------------------------------------------------------------*/
;* Document */
;*---------------------------------------------------------------------*/
-(section :title "LaTeX Engine" :file #t
- (mark "latex-engine")
+(section :title "LaTeX Engine" :file #t :ident "latex-engine"
(index "LaTeX" :note "Engine")
(p [Not surprisingly, the LaTeX engine produces ,(ref :url
diff --git a/doc/user/links.skb b/doc/user/links.skb
index 7534f47..8793e15 100644
--- a/doc/user/links.skb
+++ b/doc/user/links.skb
@@ -1,7 +1,7 @@
;;; links.skb -- Links and cross-references.
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2008, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
@@ -182,7 +182,7 @@ of a SUI file is:])
(p [SUI files can be automatically produced by the Skribilo compiler.
For instance, in order to produce the SUI file of this user
-manual, one should set the ,(ref :mark "html-engine" :text [,(tt
+manual, one should set the ,(ref :ident "html-engine" :text [,(tt
[emit-sui]) HTML custom]) to ,(tt [#t]); a ,(tt [user.sui]) file will
then be produced when the manual is compiled to HTML:]
diff --git a/doc/user/loute.skb b/doc/user/loute.skb
index 4015837..d26b0ed 100644
--- a/doc/user/loute.skb
+++ b/doc/user/loute.skb
@@ -20,9 +20,7 @@
;;; along with Skribilo. If not, see <http://www.gnu.org/licenses/>.
-(section :title "Lout Engine" :file #t
-
- (mark "lout-engine")
+(section :title "Lout Engine" :file #t :ident "lout-engine"
(index "Lout" :note "Engine")
(p [The Lout engine produces documents for the ,(ref :text [Lout
@@ -35,7 +33,7 @@ compared to typical LaTeX installations, consuming less than 10,(~)MiB
of disk space.])
(p [Skribilo's Lout engine provides lots of customization
-opportunities (currently more than the ,(ref :mark "latex-engine" :text
+opportunities (currently more than the ,(ref :ident "latex-engine" :text
[LaTeX engine])), which are shown below. It also enhances Lout by
adding new features: PDF bookmarks, high-level interface to the use of
dropped capitals, improved paragraph indentation, etc.])
diff --git a/doc/user/package.skb b/doc/user/package.skb
index eed0b09..efd9a1d 100644
--- a/doc/user/package.skb
+++ b/doc/user/package.skb
@@ -203,7 +203,7 @@ customs.] :chapter "Engines")])
(subsubsection :title [HTML Engine Customization]
(p [,(tt [html-navtabs]) is to be used in conjunction with the
-,(ref :text (code "html-engine") :mark "html-engine")
+,(ref :text (code "html-engine") :ident "html-engine")
engine. Specifically, it adds the following new customization to this
engine:])
diff --git a/doc/user/sectioning.skb b/doc/user/sectioning.skb
index f55bc23..ff9dfa2 100644
--- a/doc/user/sectioning.skb
+++ b/doc/user/sectioning.skb
@@ -1,7 +1,7 @@
;;; sectioning.skb -- Sectioning markups
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2007, 2008, 2009 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2007, 2008, 2009, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
@@ -44,7 +44,7 @@
`((:title [The title of the chapter.])
(:html-title [The title of window of the HTML browser.])
(:info-node ,[The title of the Info node (see ,(ref
-:text [Section about the Info engine] :mark "info-engine")).])
+:text [Section about the Info engine] :ident "info-engine")).])
(:number [This argument controls the chapter number.
A value of ,(tt "#t") means that Skribilo computes the chapter
number. A value of ,(tt "#f") means that the chapter has no number. A
@@ -80,7 +80,7 @@ used as the name of the file for this chapter.])
(doc-markup 'section
`((:title [The title of the chapter.])
(:info-node ,[The title of the Info node (see ,(ref
-:text [Section about the Info engine] :mark "info-engine")).])
+:text [Section about the Info engine] :ident "info-engine")).])
(:number [This argument controls the chapter number.
A value of ,(tt "#t") means that Skribilo computes the chapter
number. A value of ,(tt "#f") means that the chapter has no number. A
diff --git a/doc/user/xmle.skb b/doc/user/xmle.skb
index 1a609dc..b7c6ebe 100644
--- a/doc/user/xmle.skb
+++ b/doc/user/xmle.skb
@@ -1,7 +1,7 @@
;;; xmle.skb -- The documentation of the XML engine
;;; -*- coding: iso-8859-1 -*-
;;;
-;;; Copyright 2008 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright 2008, 2012 Ludovic Courtès <ludo@gnu.org>
;;; Copyright 2003, 2004 Manuel Serrano
;;;
;;;
@@ -24,8 +24,7 @@
;*---------------------------------------------------------------------*/
;* Document */
;*---------------------------------------------------------------------*/
-(section :title "XML Engine" :file #t
- (mark "xml-engine")
+(section :title "XML Engine" :file #t :ident "xml-engine"
(index "XML" :note "Engine")
(p [The XML engine produces a simple XML representation of Skribilo