|
Check-in Number:
|
2027 | |
| Date: |
2002-Mar-15 13:32:37 (local)
2002-Mar-15 12:32:37 (UTC) |
| User: | rse |
| Branch: | |
| Comment: |
remember abstract |
| Tickets: |
|
| Inspections: |
|
| Files: |
|
ossp-pkg/sugar/README 1.2 -> 1.3
--- README 2002/03/13 09:19:03 1.2
+++ README 2002/03/15 12:32:37 1.3
@@ -8,6 +8,23 @@
Copyright (c) 1999-2002 Ralf S. Engelschall
Copyright (c) 1999-2002 Christian Reiber
+ OSSP sugar is a markup language and corresponding processing tool for
+ writing technical documentation that uses a mostly invisible markup
+ language (so-called "syntactic sugar" in compiler construction folk
+ terminology).
+
+ The idea is that the markup looks mostly like the textual output,
+ i.e., the OSSP sugar source can be treated as its textual output
+ format ("ASCII WYSIWYG"). Additionally, the OSSP sugar markup language
+ is considered intuitive enough to be recognized and remembered
+ easily, so writing technical documentation is mainly just a matter of
+ performing a "brain dump".
+
+ OSSP sugar provides only a few markup concepts, but those are streched
+ to their maximum. So, the syntactic principle is "keep it simple,
+ stupid" (KISS), but still powerful enough to allow one to produce
+ high-quality technical documentation.
+
o Extensible Markup Language (XML)
http://www.w3.org/XML/
http://www.xml.com/
|
|
