From 50c086b4633f00f39b8132f7dc583c831b951654 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Sat, 13 Dec 2008 18:34:51 +0100 Subject: doc: Describe use of a string as `:file' for sections. * doc/user/sectioning.skb: Document the use of a string argument for `:file'. Reported by Klaus Schilling . --- doc/user/sectioning.skb | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/user/sectioning.skb b/doc/user/sectioning.skb index 1fc19cb..65287ca 100644 --- a/doc/user/sectioning.skb +++ b/doc/user/sectioning.skb @@ -49,10 +49,11 @@ number or string specifies a number to be used in lieu of the automatically computed number.]) (:toc ,[This argument controls if the chapter must be referenced in the ,(ref :mark "toc" :text "table of contents").]) - (:file [The argument must be a boolean. A value of -,(tt "#t") tells the Skribe compiler to compile that chapter in a separate -file. A value of ,(tt "#f") tells the Skribe compiler to embed the chapter -in the main target file.]) + (:file [The argument must be a boolean or a string. A +value of ,(tt "#t") tells the compiler to store that chapter in a +separate file; a value of ,(tt "#f") tells the compiler to embed the +chapter in the main target file. When the argument is a string, it is +used as the name of the file for this chapter.]) (#!rest node... [The nodes of the chapter.])) :see-also '(document section toc)) @@ -82,10 +83,11 @@ number or string specifies a number to be used in lieu of the automatically computed number.]) (:toc ,[This argument controls if the chapter must be referenced in the ,(ref :mark "toc" :text "table of contents").]) - (:file [The argument must be a boolean. A value of -,(tt "#t") tells the Skribe compiler to compile that section in a separate -file. A value of ,(tt "#f") tells the Skribe compiler to embed the chapter -in the main target file.]) + (:file [The argument must be a boolean or a string. A +value of ,(tt "#t") tells the compiler to store that section in a +separate file; a value of ,(tt "#f") tells the compiler to embed the +section in the main target file. When the argument is a string, it is +used as the name of the file for this section.]) (#!rest node... [The nodes of the section.])) :others '(subsection subsubsection) :see-also '(document chapter paragraph toc))) -- cgit v1.2.3