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_syntax_highlighting/plain.txt | 304 +++++++++++++++++++++ 1 file changed, 304 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_syntax_highlighting/plain.txt (limited to 'data/doc/manuals_generated/sisu_manual/sisu_syntax_highlighting/plain.txt') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_syntax_highlighting/plain.txt b/data/doc/manuals_generated/sisu_manual/sisu_syntax_highlighting/plain.txt new file mode 100644 index 00000000..5416a21d --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_syntax_highlighting/plain.txt @@ -0,0 +1,304 @@ +SISU - SYNTAX HIGHLIGHTING [0.58], +RALPH AMISSAH +************************************************* + +SISU SYNTAX HIGHLIGHTING +======================== + +1. EDITOR FILES, SYNTAX HIGHLIGHTING +------------------------------------ + +The directory: + + + ./data/sisu/conf/editor-syntax-etc/ + + + /usr/share/sisu/conf/editor-syntax-etc + + +contains rudimentary sisu syntax highlighting files for: + + +* (g)vim + + + package: sisu-vim + + +status: largely done + + + there is a vim syntax highlighting and folds component + + +* gedit + + +* gobby + + + file: sisu.lang + + +place in: + + + /usr/share/gtksourceview-1.0/language-specs + + +or + + + ~/.gnome2/gtksourceview-1.0/language-specs + + + status: very basic syntax highlighting + + + comments: this editor features display line wrap and is used by Goby! + + +* nano + + + file: nanorc + + +save as: + + + ~/.nanorc + + + status: basic syntax highlighting + + + comments: assumes dark background; no display line-wrap; does line breaks + + +* diakonos (an editor written in ruby) + + +file: diakonos.conf + + +save as: + + + ~/.diakonos/diakonos.conf + + +includes: + + + status: basic syntax highlighting + + +comments: assumes dark background; no display line-wrap + + +* kate & kwrite + + + file: sisu.xml + + + place in: + + + /usr/share/apps/katepart/syntax + + + or + + + ~/.kde/share/apps/katepart/syntax + + + [settings::configure kate::{highlighting,filetypes}] + + + [tools::highlighting::{markup,scripts}::*SiSU*] + + +* nedit + + + file: sisu_nedit.pats + + + nedit -import sisu_nedit.pats + + + status: a very clumsy first attempt [not really done] + + + comments: this editor features display line wrap + + +* emacs + + + files: sisu-mode.el + + + to file ~/.emacs add the following 2 lines: + + + (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") + + + (require 'sisu-mode.el) + + + [not done / not yet included] + + +* vim & gvim + + + files: + + + package is the most comprehensive sisu syntax highlighting and editor + environment provided to date (is for vim/ gvim, and is separate from the + contents of this directory) + + + status: this includes: syntax highlighting; vim folds; some error checking + + + comments: this editor features display line wrap + + +NOTE: + + +[*SiSU* parses files with long lines or line breaks, but, display linewrap +(without line-breaks) is a convenient editor feature to have for sisu markup] + + +DOCUMENT INFORMATION (METADATA) +******************************* + +METADATA +-------- + +Document Manifest @ + + + +*Dublin Core* (DC) + + +/DC tags included with this document are provided here./ + + +DC Title: _SiSU - Syntax Highlighting [0.58]_ + + +DC Creator: _Ralph Amissah_ + + +DC Rights: _Copyright (C) Ralph Amissah 2007, part of SiSU documentation, +License GPL 3_ + + +DC Type: _information_ + + +DC Date created: _2002-11-12_ + + +DC Date issued: _2002-11-12_ + + +DC Date available: _2002-11-12_ + + +DC Date modified: _2007-09-16_ + + +DC Date: _2007-09-16_ + + +*Version Information* + + +Sourcefile: _sisu_syntax_highlighting.sst_ + + +Filetype: _SiSU text insert 0.58_ + + +Sourcefile Digest, MD5(sisu_syntax_highlighting.sst)= +_1dfe1975df71459c3f56c3fd13c5789c_ + + +Skin_Digest: +MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= +_20fc43cf3eb6590bc3399a1aef65c5a9_ + + +*Generated* + + +Document (metaverse) last generated: _Sun Sep 23 04:11:02 +0100 2007_ + + +Generated by: _SiSU_ _0.59.0_ of 2007w38/0 (2007-09-23) + + +Ruby version: _ ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]_ + + + +============================================================================== + + title: SiSU - Syntax Highlighting [0.58] + + creator: Ralph Amissah + + rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, + License GPL 3 + + type: information + + subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + + date.created: 2002-11-12 + + date.issued: 2002-11-12 + + date.available: 2002-11-12 + + date.modified: 2007-09-16 + + date: 2007-09-16 + + + + + +============================================================================== +nil + +Other versions of this document: +manifest: + http://www.jus.uio.no/sisu/sisu_syntax_highlighting/sisu_manifest.html +html: + http://www.jus.uio.no/sisu/sisu_syntax_highlighting/toc.html +pdf: + http://www.jus.uio.no/sisu/sisu_syntax_highlighting/portrait.pdf + http://www.jus.uio.no/sisu/sisu_syntax_highlighting/landscape.pdf +plaintext (plain text): + http://www.jus.uio.no/sisu/sisu_syntax_highlighting/plain.txt +at: + http://www.jus.uio.no/sisu +* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) +* Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] +* Last Generated on: Sun Sep 23 04:11:51 +0100 2007 +* SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3