--- sugar.txt 2000/09/26 07:48:43 1.2
+++ sugar.txt 2000/11/08 22:04:04 1.3
@@ -31,8 +31,8 @@
| <tagged-block> | ::= | <1d-block> \| <2d-block> |
| <1d-block> | ::= | <1d-tag> <document> |
| <2d-block> | ::= | <2d-tag> <document> |
- | <1d-tag> | ::= | "||##||" \| "||\|\|||" \| "||``||" \| "||''||" \| ... |
- | <2d-tag> | ::= | "||**||" \| ... |
+ | <1d-tag> | ::= | "!!##!!" \| "!!\|\!!|" \| "!!``!!" \| "!!''!!" \| ... |
+ | <2d-tag> | ::= | "!!**!!" \| ... |
where <regular-block> is defined visually as a rectangular block of
continued text inside the document, that is a paragraph of text (without
@@ -52,41 +52,41 @@
way (to delimit indented block).
++ | tag | formatting | application |
- | ||__|| | underline | inline, block |
- | ||**|| | bold | inline, block |
- | ||//|| | italics | inline, block |
- | ||''|| | code | inline, block |
- | ||>>|| | indented | block |
- | ||==|| | paragraph header | block |
- | ||\|\||| | verbatim | inline, block (charblock only until EOL) |
- | ||[[|| | boxed | inline, block |
- | ||!!|| | centered | block |
- | ||))|| | right flushed | block |
- | ||((|| | left flushed | block |
+ | !!__!! | underline | inline, block |
+ | !!**!! | bold | inline, block |
+ | !!//!! | italics | inline, block |
+ | !!''!! | code | inline, block |
+ | !!>>!! | indented | block |
+ | !!==!! | paragraph header | block |
+ | !!\!\!!! | verbatim | inline, block (charblock only until EOL) |
+ | !![[!! | boxed | inline, block |
+ | !!%%!! | centered | block |
+ | !!))!! | right flushed | block |
+ | !!((!! | left flushed | block |
Example:
- || This line contains //italics// and **bold** words.
+ !! This line contains //italics// and **bold** words.
>> '' And this paragraph contains
indented verbatim code.
And this line again is __non-indented__ text.
o ..Links and References:..
- For referencing textual locations (both document internal and to
+ For %%referencing%% textual locations (both document internal and to
external documents), links can be specified.
++ | construct
- | ||->||[//text//]||(||//scheme//||:||//path//||)|| |
+ | !!->!![//text//]!!(!!//scheme//!!:!!//path//!!)!! |
external hyperlink via URL |
- | ||->||//text//||(||//ref//||)|| |
+ | !!->!!//text//!!(!!//ref//!!)!! |
internal hyperlink via anchor-name |
- | ||(+||//ref//||+)|| |
+ | !!(+!!//ref//!!+)!! |
internal anchor definition |
Example:
- || Header A (+hA+)
+ !! Header A (+hA+)
--------
This is text of header A. For B see ->header B(hB).
@@ -105,14 +105,14 @@
at the end of a text block:
++ | sequence | level |
- | ||==|| | I. |
- | ||--|| | II. |
- | ||~~|| | III. |
- | ||..|| | IV. |
+ | !!==!! | I. |
+ | !!--!! | II. |
+ | !!~~!! | III. |
+ | !!..!! | IV. |
Example:
- || A header line
+ !! A header line
=============
o ..List Environments:..
@@ -123,13 +123,13 @@
instead of the generic item character.
++ | construct | alternatives | type |
- | ||-|| | ||o||, ||*|| | unordered |
- | ||-.|| | ||o.||, ||*.||, m/[0-9]+\./ | ordered |
- | <block> ||::|| | | itemized |
+ | !!-!! | !!o!!, !!*!! | unordered |
+ | !!-.!! | !!o.!!, !!*.!!, m/[0-9]+\./ | ordered |
+ | <block> !!::!! | | itemized |
Example:
- || A Sugar list:
+ !! A Sugar list:
1. foo
o. bar
- baz
@@ -140,9 +140,9 @@
A generic table environment can be used for any type of data which has
to be rendered in a tabular layout. A table is a <2d-block> starting
- with a ||++|| tag. The contents of the <2d-block> consists of a
+ with a !!++!! tag. The contents of the <2d-block> consists of a
2-dimensional table specified by cells. The table cells are indicated by
- ||\||| characters. The number of columns is indicated by the first table
+ ''|'' characters. The number of columns is indicated by the first table
row. This first row can be either a complete (all cells are specified)
and regular row, or (in case the first regular row is not a complete
one, that is has multi-column cells) it can be an empty row (all cells
@@ -150,8 +150,10 @@
Example:
- || ++ | | | |
+ !!
+ ++ | | | |
| foo | !!bar | quux |
+ |
| foo | baz
bar | quux |
| bazfoo
@@ -211,7 +213,6 @@
der transformator geht bis zum letzten Paraphraph
Knoten zurueck.
-
If the "text" on hyperlinks is missing in links, the reference is printed
instead. For internal links the text is chapter and pagenumber
(except for HTML, there exists real hyperlinks).
@@ -256,129 +257,15 @@
Plain ASCII (= Sugar Quelle), roff/-man (Unix), HTML (= Online), PS (= Print)
2. Brain Dump!
-Sprach-Konzepte
----------------
-1. Escape-Konzept
- - per character
- - (per block)
-2. Simples Markup-Konzept
- - Headers
- - Stufe 1-3
- - optional automatische Nummerierung
- - Lists
- - Ordered
- - Unordered
- - Description
- - Tabellen
- - Inline Markup
- - Underline
- - Bold
- - Italics
- - Code
- - (Boxed)
-3. Block-Konzept
- - (per paragraph)
- - per line
- - per word ???
- - per character
-4. Verweis-Konzept
- - internal (reference)
- - external (hyperlink)
-5. Native-Output-Markup (if-html)
-
Optionale Zusatzfeatures
------------------------
-- ToC
+- ToC: Automatische Generierung
+- Numerierung von Headern
- Index
+- Aufrufen von Makroprozessor: m4
-1. Escape-Konzept
- - per character Idee: \
- - (per block) Idee: \\ (einsetzbar wie normales Blockkonzept)
-
-2. Simples Markup-Konzept
- - Headers
- - Stufe 1 (Part)
- Foo Bar Foo Bar Foo Bar Foo Bar
- ===============================
- xxxxx
- - Stufe 2 (Chapter)
- Foo Bar Foo Bar Foo Bar Foo Bar
- -------------------------------
- - Stufe 3 (Section)
- Foo Bar Foo Bar Foo Bar Foo Bar
- - - - - - - - - - - - - - - - -
- - Stufe 4 (Paragraph)
- Foo Bar Foo Bar Foo Bar Foo Bar
- Foo Bar Foo Bar Foo Bar Foo Bar
- Foo Bar Foo Bar Foo Bar Foo Bar
- Foo Bar Foo Bar Foo Bar Foo Bar
-
- Foo Bar Foo Bar Foo Bar Foo Bar --
-
- dsh hdsjhfdhjf klfhd jkash flhaflhaslfhlfjdha
- dsh hdsjhfdhjf klfhd jkash flhaflhaslfhlfjdha
- dsh hdsjhfdhjf klfhd jkash flhaflhaslfhlfjdha
- dsh hdsjhfdhjf klfhd jkash flhaflhaslfhlfjdha
-
- - optional automatische Nummerierung
-
- - Lists
- - Ordered
- Idee: Wir erlauben [o-*+.] _UND_ <num>. und durch <num>. wird
- die defaultmaessige Zaehlung forciert auf <num>
- 1. erster
- o xxxx
- o xxxx
- 1. xxxx
- - xxxx
- - xxxx
- 1. xxxx
- . xxxx
- o xxxx
- - Unordered
- (alle drei sind auf allen akzeptiert: o-*)
- o xxxx
- o xxxx
- - xxxx
- - xxxx
- - xxxx
- - xxxx
- - Description
- (sowohl newline als auch leading blank sind optional)
- das word::
- xxxxx
- xxxxx
- das zweite
- word::
- xxxxx
- - Code (ala TeX-Idee intern)
- || $ sjsjfkdjfd
- $ kfjd kfjdkjf
- $ xxx
- - Einrueckung
- >> ...
- - Tabellen
- XXX XXX XXXX
- foo bar quux
- foo baz quux
- bar
- bazfoo bar
-
- chrei:
-
- rse:
-
- ++ | | |
- | foo | !!bar | quux
- | foo | baz
- bar | quux
- | bazfoo
- fjfjkwq
- rwrqwd sddksjk
- | dsdjks
- | foo
- | dsdsds
-
+Tabellen:
+---------
o Tabellen sind Bloecke und werden mit ++ eingeleitet wie
andere Bloecke auch, d.h. Ende ist bei Ausrueckung oder
selber Level.
@@ -403,29 +290,10 @@
o Normungszielen haben mind.(!) 2 |'s.
o Leerzeilen erzeugen im Output soviele |'s wie die Normungszeile
vorgibt. Fuer andere Layouting-Dinge muss man z.B. ``| \_'' schreiben.
- o In einer Tabelle koennen alle Zeichenformatierungen genutzt werden,
- ausser || (Vertatim).
+ o In einer Tabelle koennen alle Zeichenformatierungen genutzt werden.
o In der Normungszeile kann mit den Zeichenformatierung-Tags
die Formatierung der Tabellenspalten angegeben werden!
- - Inline Markup
- - Header (Paragraph):
- chrei: --xx xxx xxx-- rse: -- xxx xxx xxx
- - Underline:
- chrei: __xxx__ rse: _xxx_ (= underline)
- - (Boxed):
- chrei: --- rse: [_xxx_]
- - Bold:
- chrei: **xxx** rse: *xxx* (Asterisk is fat)
- - Italics:
- chrei: //xxx// rse: /xxx/ (/ von Italic Direction)
- - Code:
- chrei: ""xxx"" rse: |xxx| (courier/teletype ist gerade schrift)
- - Paragraph:
- chrei/rse: Leerzeile!!
- - Hartes Newline
- rse: ~~
-
3. Block-Konzept
Es gibt zwei Blockkonzepte:
@@ -440,7 +308,7 @@
Zeilen und zwar solange, wie Text in der Zeile mindestens zwei Leerzeichen
weiter rechts beginnt als das einleitende Tag. Achtung: Tags stellen selbst
__nicht__ den Zeilenanfang dar! Damit kann ich also line blocks schachteln.
- (Anders gesagt: Es geht nicht um den linkenRand der Textdatein, sondern um
+ (Anders gesagt: Es geht nicht um den linken Rand der Textdatein, sondern um
den linken Rand des übergeordneten Line Blocks.)
Automatischer reflow durch den Editor ist bei character blocks **kein**
@@ -473,19 +341,14 @@
Diese Zeile beendet den Line Block.
- o. ''Ein Sonderfall: __Dieser Text hat kein Ende-Tag.
+ o. ''Ein Sonderfall: __Dieser Text hat kein Ende-1d-Tag.
Er wird dann durch das Paragraph-Ende beendet.
Ab hier also keine Unterstreichung mehr.
+ Das haben wir gemacht, weil sonst bei vergessenen Endetags
+ das Restdokument fehlformatiert wird.
-4. Verweis-Konzept(+)
- - internal (reference)
- anchor: foo (+Verweis-Konzept+) bar
- reference: foo ->Verweis-Konzept bar
- - external (hyperlink)
- reference: foo ->http://wwww bar
-
o Native-Output-Stuff
xxxx
|
