From 68f0bcc303b6ba1ac102ed24d589fe9d64a74f73 Mon Sep 17 00:00:00 2001 From: reinelt Date: Fri, 6 May 2005 05:40:03 +0000 Subject: [lcd4linux @ 2005-05-06 05:40:02 by reinelt] remove documentation pass#2 git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@544 3ae390bd-cb1e-0410-b409-cd5a39f66f1f --- documentation/drivers/Makefile | 59 --- documentation/drivers/index.xml | 14 - documentation/dtd/doc.dtd | 910 --------------------------------- documentation/dtd/references.dtd | 18 - documentation/dtd/xhtml-lat1.ent | 194 ------- documentation/dtd/xhtml-special.ent | 77 --- documentation/dtd/xhtml-symbol.ent | 241 --------- documentation/lcd4linux/Makefile | 59 --- documentation/lcd4linux/bug_report.xml | 32 -- documentation/lcd4linux/example.xml | 50 -- documentation/lcd4linux/index.xml | 17 - documentation/lcd4linux/write_doc.xml | 102 ---- documentation/plugins/Makefile | 59 --- documentation/plugins/index.xml | 14 - documentation/xsl/body.xsl | 20 - documentation/xsl/doc.xsl | 29 -- documentation/xsl/head.xsl | 68 --- documentation/xsl/helpers.xsl | 141 ----- documentation/xsl/references.xsl | 47 -- documentation/xsl/xhtml.xsl | 16 - 20 files changed, 2167 deletions(-) delete mode 100644 documentation/drivers/Makefile delete mode 100644 documentation/drivers/index.xml delete mode 100644 documentation/dtd/doc.dtd delete mode 100644 documentation/dtd/references.dtd delete mode 100644 documentation/dtd/xhtml-lat1.ent delete mode 100644 documentation/dtd/xhtml-special.ent delete mode 100644 documentation/dtd/xhtml-symbol.ent delete mode 100644 documentation/lcd4linux/Makefile delete mode 100644 documentation/lcd4linux/bug_report.xml delete mode 100644 documentation/lcd4linux/example.xml delete mode 100644 documentation/lcd4linux/index.xml delete mode 100644 documentation/lcd4linux/write_doc.xml delete mode 100644 documentation/plugins/Makefile delete mode 100644 documentation/plugins/index.xml delete mode 100644 documentation/xsl/body.xsl delete mode 100644 documentation/xsl/doc.xsl delete mode 100644 documentation/xsl/head.xsl delete mode 100644 documentation/xsl/helpers.xsl delete mode 100644 documentation/xsl/references.xsl delete mode 100644 documentation/xsl/xhtml.xsl diff --git a/documentation/drivers/Makefile b/documentation/drivers/Makefile deleted file mode 100644 index 2519f22..0000000 --- a/documentation/drivers/Makefile +++ /dev/null @@ -1,59 +0,0 @@ -# Path -DIR = $(notdir $(PWD)) -OUTPUT = ../HTML - -ifeq "$(DIR)" "lcd4linux" - DIR = -endif - -ifeq "$(DIR)" "" - XSLTPROC = xsltproc -else - XSLTPROC = xsltproc --stringparam class $(DIR) --stringparam root "../" -endif - -XMLVALID = xmllint --noout --valid - -NAMES=$(shell find . -name "*.xml" -exec basename {} .xml \;) - -html: $(patsubst %.xml,%.html,$(wildcard *.xml)) -html-forced: $(patsubst %.xml,%.html-forced,$(wildcard *.xml)) - -%.html: %.xml %.xml-check output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$@ - -%.html-forced: %.xml output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$(patsubst %.xml,%.html,$<) - -check: $(patsubst %.xml, %.xml-check, $(wildcard *.xml)) - -%.xml-check: %.xml - @echo "*** Validation of $<" - $(XMLVALID) $< - -output: - test -d $(OUTPUT) || `mkdir $(OUTPUT); cp ../data/doc.css $(OUTPUT); cp -R ../data/images $(OUTPUT)` - test -d $(OUTPUT)/$(DIR) || mkdir $(OUTPUT)/$(DIR) - -clean: - rm -f $(OUTPUT)/$(DIR)/*.html - -clean-bak: - rm -f *~ *.bak - -help: - @echo -e "" - @echo -e "Usage :" - @echo -e "-------" - @echo -e "make or make html : builds all possible html pages from xml files" - @echo -e "make %.html : builds the %.html page from %.xml" - @echo -e "" - @echo -e "make html-forced : builds all possible html pages from xml files (no validity check)" - @echo -e "make %.html-forced : builds the %.html page from %.xml (no validity check)" - @echo -e "" - @echo -e "make check : checks the validity of all possible xml files" - @echo -e "make %.xml-check : checks the validity of %.xml" - @echo -e "" - @echo -e "make clean : deletes all generated html pages" - @echo -e "make clean-bak : deletes *~ and *.bak files" - @echo -e "" diff --git a/documentation/drivers/index.xml b/documentation/drivers/index.xml deleted file mode 100644 index 12ba14e..0000000 --- a/documentation/drivers/index.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - &L4L; drivers - drivers_index - - - -

Drivers

- - - diff --git a/documentation/dtd/doc.dtd b/documentation/dtd/doc.dtd deleted file mode 100644 index 3b1a778..0000000 --- a/documentation/dtd/doc.dtd +++ /dev/null @@ -1,910 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -%HTMLlat1; - - -%HTMLsymbol; - - -%HTMLspecial; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/dtd/references.dtd b/documentation/dtd/references.dtd deleted file mode 100644 index fc54fde..0000000 --- a/documentation/dtd/references.dtd +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - diff --git a/documentation/dtd/xhtml-lat1.ent b/documentation/dtd/xhtml-lat1.ent deleted file mode 100644 index 293d2ba..0000000 --- a/documentation/dtd/xhtml-lat1.ent +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/dtd/xhtml-special.ent b/documentation/dtd/xhtml-special.ent deleted file mode 100644 index fefb15d..0000000 --- a/documentation/dtd/xhtml-special.ent +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/dtd/xhtml-symbol.ent b/documentation/dtd/xhtml-symbol.ent deleted file mode 100644 index e950aad..0000000 --- a/documentation/dtd/xhtml-symbol.ent +++ /dev/null @@ -1,241 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/lcd4linux/Makefile b/documentation/lcd4linux/Makefile deleted file mode 100644 index 2519f22..0000000 --- a/documentation/lcd4linux/Makefile +++ /dev/null @@ -1,59 +0,0 @@ -# Path -DIR = $(notdir $(PWD)) -OUTPUT = ../HTML - -ifeq "$(DIR)" "lcd4linux" - DIR = -endif - -ifeq "$(DIR)" "" - XSLTPROC = xsltproc -else - XSLTPROC = xsltproc --stringparam class $(DIR) --stringparam root "../" -endif - -XMLVALID = xmllint --noout --valid - -NAMES=$(shell find . -name "*.xml" -exec basename {} .xml \;) - -html: $(patsubst %.xml,%.html,$(wildcard *.xml)) -html-forced: $(patsubst %.xml,%.html-forced,$(wildcard *.xml)) - -%.html: %.xml %.xml-check output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$@ - -%.html-forced: %.xml output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$(patsubst %.xml,%.html,$<) - -check: $(patsubst %.xml, %.xml-check, $(wildcard *.xml)) - -%.xml-check: %.xml - @echo "*** Validation of $<" - $(XMLVALID) $< - -output: - test -d $(OUTPUT) || `mkdir $(OUTPUT); cp ../data/doc.css $(OUTPUT); cp -R ../data/images $(OUTPUT)` - test -d $(OUTPUT)/$(DIR) || mkdir $(OUTPUT)/$(DIR) - -clean: - rm -f $(OUTPUT)/$(DIR)/*.html - -clean-bak: - rm -f *~ *.bak - -help: - @echo -e "" - @echo -e "Usage :" - @echo -e "-------" - @echo -e "make or make html : builds all possible html pages from xml files" - @echo -e "make %.html : builds the %.html page from %.xml" - @echo -e "" - @echo -e "make html-forced : builds all possible html pages from xml files (no validity check)" - @echo -e "make %.html-forced : builds the %.html page from %.xml (no validity check)" - @echo -e "" - @echo -e "make check : checks the validity of all possible xml files" - @echo -e "make %.xml-check : checks the validity of %.xml" - @echo -e "" - @echo -e "make clean : deletes all generated html pages" - @echo -e "make clean-bak : deletes *~ and *.bak files" - @echo -e "" diff --git a/documentation/lcd4linux/bug_report.xml b/documentation/lcd4linux/bug_report.xml deleted file mode 100644 index 49bf743..0000000 --- a/documentation/lcd4linux/bug_report.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - How to report bugs or get support - bug_report - - - - - -You've checked twice your configuration, but &l4l; keeps complaining, prints horrible things on your display or even crashes. What to do ? - -

Configuration problems and minor bugs

- -You should contact the lcd4linux-users maillist, and post a detailled report containing at least : - -If you use some plugins (mysql, mail, ...), lcd4linux.conf may contain passwords and other private information. For your privacy, we recommend you to replace these information with ***** before attaching your configuration file - - - diff --git a/documentation/lcd4linux/example.xml b/documentation/lcd4linux/example.xml deleted file mode 100644 index 63702e0..0000000 --- a/documentation/lcd4linux/example.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - The title of the page The title of the page - 0.1 - doc_example - - - - SourceForge - - - - The first, and only version ever ;) - - - TEST - - - - - -

This is the text of the page, we can use xhtml tags here and there are some helpers :

-<cmd> Will be used to indicate console commands, or other things -<conf> Is to format lcd4linux.conf examples -<note> Will display a div with the message, to add a tip, or an explanation -<warn> Will work just as <note>, but for more important messages -<new> is to display boxes with news, for the main page or, as an example for displays/plugins pages to show news in the features
- - - -There will be other helpers : <image>, <link>, <table> ...
- -If you look at the sources of this page, there are a lot of information in the head. They will be used for internal processing, and some will be displayed (for example <links> will define links to be put in a 'See also' box, with links to related articles, websites, ...
- -We'll use 'standard' xhtml tags <br /> <b> <i> <tt> <small> <big> and others, not really proceced by xslt. -

<h2>

<h3>

<h4>

<h5>
<h6>
- -

test

-

one

-

two

-

three

-

AAAA

-

one

-

two

-

three

- - diff --git a/documentation/lcd4linux/index.xml b/documentation/lcd4linux/index.xml deleted file mode 100644 index 93f75eb..0000000 --- a/documentation/lcd4linux/index.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - &L4L; documentation index - index - - -

&L4L;

- -

Drivers

- -

Plugins

- - - diff --git a/documentation/lcd4linux/write_doc.xml b/documentation/lcd4linux/write_doc.xml deleted file mode 100644 index b8d243d..0000000 --- a/documentation/lcd4linux/write_doc.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - How to write documentation for &l4l; ? - write_doc - - - -

Overview

-

The &l4l; documentation is composed of XML files which are processed with XSL stylesheets to produce XHTML files. -There these XML files are writen in a syntax similar to the HTML syntax, plus some helpers.

-

The whole documentation is generated through a make system, which uses xmllint to check the validy of the xml files and xsltproc to process them and generate the XHTML pages. These two programs are mandatory

- -

The syntax

-A doc page looks like this : -<?xml version="1.0" encoding="UTF-8" standalone="no" ?> -<?xml-stylesheet type="text/xsl" href="../xsl/doc.xsl"?> -<!DOCTYPE doc SYSTEM "../dtd/doc.dtd"> -<doc> -<head> - <title>How to write documentation for &l4l; ?</title> - <ref>write_doc</ref> - <links> - <link ref="http://lcd4linux.sf.net"/> - </links> -</head> -<body> -... -</body> -</doc> - - -
  • The three first lines are the preambule of the file, don't touch them.
    • -
  • The root of the document is <doc>, it's the equivalent of <html>.
    • -
  • Then, there's a <head> node, containing the information about the page. See later for the childs.
    • -
  • The core of the doc is the <body> node, like in HTML, containing the content.
    • - -

    The <head>

    -The head contains some information about the document : -
  • <title> is the title of the document, which will be displayed as a <h1>
    • -
  • <ref> is a unique reference for the document, which is assumed to be the same as in references.xml (we'll discuss later about this file)
    • -
  • <links> is the section responsible of the "See Alo" box, containing links to other help pages, or to urls. It can contain several <link> elements, whose syntax is explained in the next part.
    • -
  • There may be other elements, but we'll only use these ones for now.
    • - -

    The helpers

    -You can use a lot of helpers in the body : -
  • <link> is a helper to create links. It is used with one of these two arguments : -
      -
    • <link ref="xxx"/> will create a link to the documentation page associated with this reference (defined in references.xml)
      • -
    • <link url="http://..."/> will create a link to the url
      • -
    -Note that if you don't provide a text, the text of the link will be the label of the reference or the url. You can specify a text writing <link url="http://...">TEXT</link> -
    • -As this is XML, you must close all the tags you open, or use self-closing tags for empty ones :
    For example, you have to write <br/> but not <br>.     - -
  • <cmd> Opens a box with write text on black background, used to indicate something's happening in a console (compilation, logs, ...). The text is in "pre" mode, so spaces and newlines are kept, no need of &nbsp; or <br/>, But beware of < and > (you must replace them with &lt; and &gt;)
    • -xav:~$ echo "An example of <cmd> box" -An example of <cmd> box -xav:~$ - -
  • <conf> works like <cmd> but with black text on grey background, to print lcd4linux.conf examples.
    • -Widget Lightning { - class 'icon' - speed 100 - visible cpu('busy', 500)-50 - bitmap { - row1 '...***' - row2 '..***.' - row3 '.***..' - row4 '.****.' - row5 '..**..' - row6 '.**...' - row7 '**....' - row8 '*.....' - } -} -
  • <note> is to display a box with a small icon, to point out a detail, or an advice
    • -To dry a wet cat, don't put it in a microwave ;) -
  • <warn> works like <note> but with a red exclamation mark and a red border, to display warnings. In general, use a note for a detail or an advice and warn to point configuration problems, hardware hazards, or other happy things ;)
    • -We're not responsible for damages caused to your microwave if you don't read the above note ! -
  • <index> is a cool thing. It displays the list of pages of a specified class. It's used to display indexes. For example <index class="drivers"/> will display a list of all pages about drivers. If there's no class specified, it'll parse the list of pages of the "lcd4linux" class.
    • -
  • <new> is in the DTD, but is not yet implemented :/
    • -
  • You can use any other XHTML-valid tag. The most used should be : <br/> <h2> <h3> <li> <b> <i> <tt> ...
    • - -

    references.xml

    -There's a file in data/ called references.xml. It isn't processed directly, but is used to parse links and indexes. It's syntax is quite straightforward, so I won't explain it.
    -You must add a new entry in it for each page you write so that other pages can have links to it and index it. -A null <class/> attribute corresponds to the lcd4linux class. It's not a bug, it's a feature, used to make links (the lcd4linux class is in the root of the documentation) - -

    The compilation system

    -The documentation is compiled with a Makefile build system. There's a toplevel Makefile which calls the apropriate targets in each subdirs which contains xml files (for the moment, lcd4linux, drivers and plugins). In these subdirs, the Makefile is a link to Makefile.generic.
    -To compile the documentation, just type make at the toplevel, and look in the HTML folder. Type make help for help ;) -Two programs are mandatory to build the documentation : -
    • xmllint from libxml2 is used to validate the xml pages to be processed. It's in the debian package libxml2
      • -
    • xsltproc from libxslt processes the xml files to generate the html pages. It's in the libxslt tarballs or in the xsltproc debian package
    -     - -     diff --git a/documentation/plugins/Makefile b/documentation/plugins/Makefile deleted file mode 100644 index 2519f22..0000000 --- a/documentation/plugins/Makefile +++ /dev/null @@ -1,59 +0,0 @@ -# Path -DIR = $(notdir $(PWD)) -OUTPUT = ../HTML - -ifeq "$(DIR)" "lcd4linux" - DIR = -endif - -ifeq "$(DIR)" "" - XSLTPROC = xsltproc -else - XSLTPROC = xsltproc --stringparam class $(DIR) --stringparam root "../" -endif - -XMLVALID = xmllint --noout --valid - -NAMES=$(shell find . -name "*.xml" -exec basename {} .xml \;) - -html: $(patsubst %.xml,%.html,$(wildcard *.xml)) -html-forced: $(patsubst %.xml,%.html-forced,$(wildcard *.xml)) - -%.html: %.xml %.xml-check output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$@ - -%.html-forced: %.xml output - $(XSLTPROC) $< > $(OUTPUT)/$(DIR)/$(patsubst %.xml,%.html,$<) - -check: $(patsubst %.xml, %.xml-check, $(wildcard *.xml)) - -%.xml-check: %.xml - @echo "*** Validation of $<" - $(XMLVALID) $< - -output: - test -d $(OUTPUT) || `mkdir $(OUTPUT); cp ../data/doc.css $(OUTPUT); cp -R ../data/images $(OUTPUT)` - test -d $(OUTPUT)/$(DIR) || mkdir $(OUTPUT)/$(DIR) - -clean: - rm -f $(OUTPUT)/$(DIR)/*.html - -clean-bak: - rm -f *~ *.bak - -help: - @echo -e "" - @echo -e "Usage :" - @echo -e "-------" - @echo -e "make or make html : builds all possible html pages from xml files" - @echo -e "make %.html : builds the %.html page from %.xml" - @echo -e "" - @echo -e "make html-forced : builds all possible html pages from xml files (no validity check)" - @echo -e "make %.html-forced : builds the %.html page from %.xml (no validity check)" - @echo -e "" - @echo -e "make check : checks the validity of all possible xml files" - @echo -e "make %.xml-check : checks the validity of %.xml" - @echo -e "" - @echo -e "make clean : deletes all generated html pages" - @echo -e "make clean-bak : deletes *~ and *.bak files" - @echo -e "" diff --git a/documentation/plugins/index.xml b/documentation/plugins/index.xml deleted file mode 100644 index 8e803ae..0000000 --- a/documentation/plugins/index.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - &L4L; plugins - plugins_index - - - -

    Plugins

    - - -     diff --git a/documentation/xsl/body.xsl b/documentation/xsl/body.xsl deleted file mode 100644 index 8b13ebd..0000000 --- a/documentation/xsl/body.xsl +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/documentation/xsl/doc.xsl b/documentation/xsl/doc.xsl deleted file mode 100644 index 1a2045f..0000000 --- a/documentation/xsl/doc.xsl +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/xsl/head.xsl b/documentation/xsl/head.xsl deleted file mode 100644 index 7d975dd..0000000 --- a/documentation/xsl/head.xsl +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - - - - - - stylesheet - - - doc.css - - text/css - - - - - - - - - - - - - - - - - - - - - -
    -     - - - - links - - title - See Also - - - - - - index - - - - index.html - - < Index - - - - - -     diff --git a/documentation/xsl/helpers.xsl b/documentation/xsl/helpers.xsl deleted file mode 100644 index df91a4a..0000000 --- a/documentation/xsl/helpers.xsl +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - cmd - - - - - - - conf - - - - - - - note - - - - images/note-icon.png - - - Note : - - icon - - - - - - - - warn - - - - images/warn-icon.png - - - Warning : - - icon - - - - - - - - new - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NO LABEL - - - - - - - - - - - - - - - - - - - - - - - : invalid link ! - - - - - - - - - - - - - - - - - - diff --git a/documentation/xsl/references.xsl b/documentation/xsl/references.xsl deleted file mode 100644 index 4dc47f6..0000000 --- a/documentation/xsl/references.xsl +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/documentation/xsl/xhtml.xsl b/documentation/xsl/xhtml.xsl deleted file mode 100644 index 1f5cb98..0000000 --- a/documentation/xsl/xhtml.xsl +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - -- cgit v1.2.3