diff options
| author | Ludovic Courtès | 2008-04-22 22:14:02 +0200 |
|---|---|---|
| committer | Ludovic Courtès | 2008-04-22 22:14:02 +0200 |
| commit | 527493e181f87f94d15fa4d37832aca928240738 (patch) | |
| tree | 9fe2d2350881523a7b1472e61347fd57372967ee /doc/user | |
| parent | 01403d4cd9181782afc6a739c6273e6814edd365 (diff) | |
| download | skribilo-527493e181f87f94d15fa4d37832aca928240738.tar.gz skribilo-527493e181f87f94d15fa4d37832aca928240738.tar.lz skribilo-527493e181f87f94d15fa4d37832aca928240738.zip | |
Fix SUI documentation.
* doc/user/htmle.skb: Add link to section `sui'.
* doc/user/links.skb (sui): Fix references to Skribe and SUI production
example and description.
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/htmle.skb | 3 | ||||
| -rw-r--r-- | doc/user/links.skb | 23 |
2 files changed, 16 insertions, 10 deletions
diff --git a/doc/user/htmle.skb b/doc/user/htmle.skb index 47a5f97..5132999 100644 --- a/doc/user/htmle.skb +++ b/doc/user/htmle.skb @@ -48,7 +48,8 @@ used in replacement of the ,(code "css") custom in order to produce stand alone HTML documents.]) (js ,[A URL or a list of URLs of JavaScript programs used by the document.]) - (emit-sui [Emit a SUI file for this document.]) + (emit-sui ,[Emit a SUI file for this document (see ,(numref +:text [Section] :ident "sui") for details).]) (background "The background color of the document.") (foreground "The foreground color of the document.") ;; the margins diff --git a/doc/user/links.skb b/doc/user/links.skb index 812bd32..53b11a9 100644 --- a/doc/user/links.skb +++ b/doc/user/links.skb @@ -163,10 +163,11 @@ introduces mail annotation in a Skribe document.]) (section :title "Skribe URL Index" :ident "sui" -(p [A ,(emph "Skribe URL Index") (henceforth ,(sc "Sui")) describes the -marks that are available in a Skribe document. It is to be used to -make Skribe marks available to other Skribe documents. The syntax -of a ,(sc "Sui") file is:]) +(p [A ,(emph "Skribe URL Index") (henceforth SUI) describes the marks +that are available in a Skribe or Skribilo document. It is to be used +to make marks available to other Skribe/Skribilo documents through the +,(param :skribe) option of the ,(markup-ref "ref") markup. The syntax +of a SUI file is:]) (disp :verb #t :bg *prgm-skribe-color* [ <sui> --> (skribe-url-index <title> @@ -178,12 +179,16 @@ of a ,(sc "Sui") file is:]) (subsubsection <sui-ref>*)) <sui-ref> --> (<string> :file <file-name> :mark <string>)]) -(p [,(sc "Sui") files can be automatically produced by the Skribe compiler. -For instance, in order to produce the ,(sc "Sui") file of this user -manual, one should write:]) +(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 +[emit-sui]) HTML custom]) to ,(tt [#t]); a ,(tt [user.sui]) file will +then be produced when the manual is compiled to HTML:] -(disp :verb #t [ -$ skribilo user.skb -o user.sui]))) +(disp :verb #t + [skribilo -t html -o user.html user.skb]) + +))) ;;; LocalWords: Hyperlinks HTML URL url |