From d8bbaa02ff00d12322fe70d60c1568d88f364b42 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Wed, 7 Jan 2009 18:13:31 +0100 Subject: doc: Use `:info-node' to avoid name clashes; document it. * doc/user/eq.skb (Syntax): Add `:info-node' to avoid name clash. * doc/user/package.skb (Example): Likewise. * doc/user/pie.skb (Syntax): Likewise. * doc/user/skribilo-config.skb (Synopsis): Likewise. * doc/user/slide.skb (Example): Likewise. * doc/user/sectioning.skb: Document the `:info-node' option. --- doc/user/eq.skb | 3 ++- doc/user/package.skb | 3 ++- doc/user/pie.skb | 3 ++- doc/user/sectioning.skb | 6 +++++- doc/user/skribilo-config.skb | 5 ++++- doc/user/slide.skb | 4 +++- 6 files changed, 18 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/user/eq.skb b/doc/user/eq.skb index 8a49a42..290a048 100644 --- a/doc/user/eq.skb +++ b/doc/user/eq.skb @@ -1,6 +1,6 @@ ;;; eq.skb -- Equation formatting. ;;; -;;; Copyright 2006, 2007, 2008 Ludovic Courtès +;;; Copyright 2006, 2007, 2008, 2009 Ludovic Courtès ;;; ;;; ;;; This program is free software; you can redistribute it and/or modify @@ -44,6 +44,7 @@ such as, for example, the following:] describe equations, as well as the rendering options.]) (section :title [Syntax] + :info-node [Eq Syntax] (p [To start with, let's have a look at a concrete example. ] diff --git a/doc/user/package.skb b/doc/user/package.skb index 4188c53..f9a7bbf 100644 --- a/doc/user/package.skb +++ b/doc/user/package.skb @@ -1,6 +1,6 @@ ;;; package.skb -- Packages ;;; -;;; Copyright 2007, 2008 Ludovic Courtès +;;; Copyright 2007, 2008, 2009 Ludovic Courtès ;;; Copyright 2001, 2004, 2005 Manuel Serrano ;;; ;;; @@ -231,6 +231,7 @@ the tabs). The attribute ,(param :no-tabs) disable tabs for this container.])) (subsubsection :title [Example] + :info-node [Package Example] (resolve (lambda (n e env) ;; XXX: In Lout, the sample code is unbreakable for diff --git a/doc/user/pie.skb b/doc/user/pie.skb index ace37f2..34b489f 100644 --- a/doc/user/pie.skb +++ b/doc/user/pie.skb @@ -1,6 +1,6 @@ ;;; pie.skb -- Pie charts. ;;; -;;; Copyright 2006 Ludovic Courtès +;;; Copyright 2006, 2009 Ludovic Courtès ;;; ;;; ;;; This program is free software; you can redistribute it and/or modify @@ -48,6 +48,7 @@ textures (particularly useful for black & white printouts) could be added in the future.]) (section :title [Syntax] + :info-node [Pie Syntax] (p [Let us start with a simple example:] diff --git a/doc/user/sectioning.skb b/doc/user/sectioning.skb index 65287ca..0e859f1 100644 --- a/doc/user/sectioning.skb +++ b/doc/user/sectioning.skb @@ -1,6 +1,6 @@ ;;; sectioning.skb -- Sectioning markups ;;; -;;; Copyright 2007, 2008 Ludovic Courtès +;;; Copyright 2007, 2008, 2009 Ludovic Courtès ;;; Copyright 2003, 2004 Manuel Serrano ;;; ;;; @@ -42,6 +42,8 @@ (doc-markup 'chapter `((: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")).]) (: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 @@ -76,6 +78,8 @@ 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")).]) (: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/skribilo-config.skb b/doc/user/skribilo-config.skb index ae3dd22..b999145 100644 --- a/doc/user/skribilo-config.skb +++ b/doc/user/skribilo-config.skb @@ -1,6 +1,6 @@ ;;; skribilo-config.skb -- The `skribilo-config' tool ;;; -;;; Copyright 2007, 2008 Ludovic Courtès +;;; Copyright 2007, 2008, 2009 Ludovic Courtès ;;; Copyright 2004 Manuel Serrano ;;; ;;; @@ -32,10 +32,13 @@ program that gives information about the current configuration.]) ;; Synopsis (section :title "Synopsis" :number #f + :info-node "skribilo-config Synopsis" + (compiler-command "skribilo-config" "options")) ;; Description (section :title "Description" :number #f + :info-node "skribilo-config Description" (p [The ,(code "skribilo-config") program gives information about the Skribilo configuration, such as the module installation path, version diff --git a/doc/user/slide.skb b/doc/user/slide.skb index aa7edb7..5c88baa 100644 --- a/doc/user/slide.skb +++ b/doc/user/slide.skb @@ -1,6 +1,6 @@ ;;; slide.skb -- Slides ;;; -;;; Copyright 2006, 2008 Ludovic Courtès +;;; Copyright 2006, 2008, 2009 Ludovic Courtès ;;; Copyright 2004 Manuel Serrano ;;; ;;; @@ -189,6 +189,8 @@ output format does not support embedded application.])) ;* Example */ ;*---------------------------------------------------------------------*/ (section :title "Example" + :info-node "Slide Example" + (p [Here is a complete example of Skribilo slides:]) (if (and (engine-format? "html") -- cgit v1.2.3