From 32ac2083ec2bd39c9b1c4f3b5047dfb1b2b81e8d Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Mon, 31 Mar 2008 17:35:56 +0200 Subject: doc: Fix "Hello World" examples. * doc/user/start.skb, doc/user/src/start?.skb: Fix inconsistencies. Reported by R. Clayton . --- THANKS | 1 + doc/user/src/start1.skb | 6 ++++-- doc/user/src/start2.skb | 7 +++++-- doc/user/src/start3.skb | 13 +++++++++---- doc/user/src/start4.skb | 24 +++++++++++++----------- doc/user/start.skb | 9 +++++---- 6 files changed, 37 insertions(+), 23 deletions(-) diff --git a/THANKS b/THANKS index 593e1d0..6f0a6ea 100644 --- a/THANKS +++ b/THANKS @@ -9,4 +9,5 @@ upon which Skribilo is based: I would also like to thank the following people who contributed to Skribilo through suggestions, bug reports or patches: + R. Clayton Barrie Stott diff --git a/doc/user/src/start1.skb b/doc/user/src/start1.skb index 4e37dda..e18bc6c 100644 --- a/doc/user/src/start1.skb +++ b/doc/user/src/start1.skb @@ -1,2 +1,4 @@ -(document :title [Hello World!] [ -This is a very simple text.]) +(document :title [Hello World!] + :html-title [Hello World Example] + + [This is a very simple text.]) diff --git a/doc/user/src/start2.skb b/doc/user/src/start2.skb index 9fcfdbf..1f22892 100644 --- a/doc/user/src/start2.skb +++ b/doc/user/src/start2.skb @@ -1,2 +1,5 @@ -(document :title [Hello World!] [ -This is a ,(bold [very]) ,(it [simple]) ,(color :fg [red] [text]).]) +(document :title [Hello World!] + :html-title [Hello World Example] + + [This is a ,(bold [very]) ,(it [simple]) +,(color :fg [red] [text]).]) diff --git a/doc/user/src/start3.skb b/doc/user/src/start3.skb index 65fa738..5f9bf4b 100644 --- a/doc/user/src/start3.skb +++ b/doc/user/src/start3.skb @@ -1,10 +1,15 @@ (document :title [Hello World!] -(chapter :title [A first Section] [ - This is a ,(bold [very]) ,(it [simple]) ,(color :fg [red] [text]).]) + (chapter :title [A first Section] + + [This is a ,(bold [very]) ,(it [simple]) +,(color :fg [red] [text]).]) + + (chapter :title [A second Section] + + [That section contains an ,(bold [itemize]) +construction: -(chapter :title [A second Section] [ - That section contains an ,(bold itemize) construction: ,(itemize (item [first item]) (item [second item]) (item [third item]))])) diff --git a/doc/user/src/start4.skb b/doc/user/src/start4.skb index 31fba0c..0d792a2 100644 --- a/doc/user/src/start4.skb +++ b/doc/user/src/start4.skb @@ -1,13 +1,15 @@ -(document :title [Various links] +(document :title [Various Links] - (chapter :title "A Section" [ -The first link points to an external web page. Here we point to a -,(ref :url [http://slashdot.org/] [Slashdot]) -web page. The second one points to the second -,(ref :section [A second Section] [Section]) -of that document.]) + (chapter :title [A Section] + + [The first link points to an external web page. +Here we point to a ,(ref :url "http://slashdot.org/" +:text [Slashdot]) web page. The second one points to +the second ,(ref :chapter "A Second Section" :text +[section]) of that document.]) - (chapter :title [A second Section] [ -The last links points to the first -,(ref :scribe [user.scr] :figure [A simple web page] [Figure]) -of the Scribe User Manual.])) + (chapter :title "A Second Section" + + [The last link points to the first +,(ref :skribe "user.sui" :chapter "Introduction" +:text [chapter]) of the Skribilo User Manual.])) diff --git a/doc/user/start.skb b/doc/user/start.skb index cea5417..addb51c 100644 --- a/doc/user/start.skb +++ b/doc/user/start.skb @@ -1,6 +1,6 @@ ;;; start.skb -- Getting started with Skribilo ;;; -;;; Copyright 2007 Ludovic Courtès +;;; Copyright 2007, 2008 Ludovic Courtès ;;; Copyright 2003, 2004 Manuel Serrano ;;; ;;; @@ -47,7 +47,7 @@ The HTML source file for such a page should look like: -Hello world Example +Hello World Example

Hello World!

@@ -76,7 +76,7 @@ The HTML source file for such a document should look like: -Hello world Example +Hello World Example

Hello World!

@@ -172,7 +172,8 @@ can be used to ease the construction of such documents as illustrated below. This text has been generated with the following piece of code ,(prgm :language skribe [ (itemize - (map (lambda (x) (item \[The square of \,(bold x) is \,(bold (* x x))\])) + (map (lambda (x) + (item \[The square of \,(bold x) is \,(bold (* x x))\])) '(1 2 3 4 5 6 7 8 9))) ])])) -- cgit v1.2.3