From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_markup/markup.html | 743 +++++++++++++++++++++ 1 file changed, 743 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_markup/markup.html (limited to 'data/doc/manuals_generated/sisu_manual/sisu_markup/markup.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_markup/markup.html b/data/doc/manuals_generated/sisu_manual/sisu_markup/markup.html new file mode 100644 index 00000000..7d8732f9 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_markup/markup.html @@ -0,0 +1,743 @@ + + + + + + markup - + SiSU + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + +

+ +

SiSU -->

+

+ + + + + + + + + + + + + + + + + +

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ SiSU +

+

+ Markup [0.58] +

+

+ Ralph Amissah + +

+

+ copy @ + + SiSU + +

+ + +

+ +

+

+ 1 +

+

+ + +

+ +

+

+ 2 +

+

+ + +

+ +

+

+ + +

+

+ + 1. Introduction to SiSU Markup ¹ +

+

+

+ 3 +

+

+ + 1.1 Summary + +

+ + 1.2 Markup Examples + +

+ + 1.2.1 Online + +

+ + 1.2.2 Installed + +

+ + +

+ +

+ 1.1 Summary +

+

+ 4 +

+

+ + +

+

+ SiSU source documents are plaintext (UTF-8) ² files +

+

+

+ 5 +

+

+ + +

+

+ All paragraphs are separated by an empty line. +

+

+ 6 +

+

+ + +

+

+ Markup is comprised of: +

+

+ 7 +

+

+ + +

+

+ at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) +

+

+ 8 +

+

+ + +

+

+ followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes: +

+

+ 9 +

+

+ + +

+

+ heading levels defines document structure +

+

+ 10 +

+

+ + +

+

+ text basic attributes, italics, bold etc. +

+

+ 11 +

+

+ + +

+

+ grouped text (objects), which are to be treated differently, such as code blocks or poems. +

+

+ 12 +

+

+ + +

+

+ footnotes/endnotes +

+

+ 13 +

+

+ + +

+

+ linked text and images +

+

+ 14 +

+

+ + +

+

+ paragraph actions, such as indent, bulleted, numbered-lists, etc. +

+

+ 15 +

+

+ + +

+

+ Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup +

+

+ 16 +

+

+ + +

+ +

+ 1.2 Markup Examples +

+

+ 17 +

+

+ + +

+ +

+ 1.2.1 Online +

+

+ 18 +

+

+ + +

+

+ Online markup examples are available together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/2.html> or from <http://www.jus.uio.no/sisu/sisu_examples/> +

+

+

+ 19 +

+

+ + +

+

+ There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/> +

+

+

+ 20 +

+

+ + +

+

+ Some example marked up files are available as html with syntax highlighting for viewing: <http://www.jus.uio.no/sisu/sample/syntax> +

+

+

+ 21 +

+

+ + +

+

+ an alternative presentation of markup syntax: <http://www.jus.uio.no/sisu/sample/on_markup.txt> +

+

+

+ 22 +

+

+ + +

+ +

+ 1.2.2 Installed +

+

+ 23 +

+

+ + +

+

+ With SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/sisu_markup_samples/non-free +

+

+ 24 +

+

+^

+ + +

+

+ ^1. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful. +

+

+

+ + +

+

+ ^2. files should be prepared using UTF-8 character encoding +

+

+

+ + + +

+ +

SiSU -->

+

+ + + + + + + + + + + + + + + + + +

+

+ + + A-Z + + +

+ +

+

+

+ + + + + + +

+

+

+ + + + +

+ + + + + + + + +

+ +
+ + + + + +	+ + + Output generated by + + SiSU + + 0.59.0 2007-09-23 (2007w38/0) + + + SiSU + + Copyright ^© Ralph Amissah + 1997, current 2007. + All Rights Reserved. + + + SiSU + + is software for document structuring, publishing and search, + + + www.jus.uio.no/sisu + + and + + www.sisudoc.org + + + w3 since October 3 1993 + + ralph@amissah.com + + +	+ + SiSU using: + Standard SiSU markup syntax, + Standard SiSU meta-markup syntax, and the + Standard SiSU object citation numbering and system, (object/text positioning system) + + Copyright ^© Ralph Amissah 1997, current 2007. + All Rights Reserved. + +
+ + + + + +	+ + + SiSU + + is released under + GPLv3 + or later, + <http://www.gnu.org/licenses/gpl.html> + +	+ + SiSU, developed using + + Ruby + + on + + Debian/Gnu/Linux + + software infrastructure, + with the usual GPL (or OSS) suspects. + + Better - "performance, reliability, scalability, security & total cost of ownership" + [not to mention flexibility & choice] use of and adherence to open standards (where practical and fair) and it is software libre. + + Get With the Future + + Way Better! + + +

+ + + + + +

+
+ + + +
+ +
+

+ + +SiSU manual + +

+ + + + +

SiSU introduction

+

+

+

SiSU configuration

+

+

SiSU help sources

+ +
+

+ + +SiSU + +

+ + + + +

What does SiSU do? Summary

+

SiSU Book Samples and Markup Examples

+

+

+

+

+

+

Wikipedia entry

+

+

Ruby Application Archive

+ + +

+ \ No newline at end of file -- cgit v1.2.3