From 527493e181f87f94d15fa4d37832aca928240738 Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Tue, 22 Apr 2008 22:14:02 +0200 Subject: 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. --- doc/user/links.skb | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) (limited to 'doc/user/links.skb') 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* [ --> (skribe-url-index @@ -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 -- cgit v1.2.3