From 21d19e4dbe9a3a1f724a1963d13af21004a06e55 Mon Sep 17 00:00:00 2001 From: reinelt Date: Wed, 2 Jun 2004 05:28:06 +0000 Subject: [PATCH] [lcd4linux @ 2004-06-02 05:27:59 by reinelt] added documentation tree git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@458 3ae390bd-cb1e-0410-b409-cd5a39f66f1f --- documentation/Makefile | 32 + documentation/Makefile.generic | 59 ++ documentation/data/doc.css | 82 +++ documentation/data/images/note-icon.png | Bin 0 -> 2288 bytes documentation/data/images/warn-icon.png | Bin 0 -> 2592 bytes documentation/data/references.xml | 65 ++ 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 + 26 files changed, 2405 insertions(+) create mode 100644 documentation/Makefile create mode 100644 documentation/Makefile.generic create mode 100644 documentation/data/doc.css create mode 100644 documentation/data/images/note-icon.png create mode 100644 documentation/data/images/warn-icon.png create mode 100644 documentation/data/references.xml create mode 100644 documentation/drivers/Makefile create mode 100644 documentation/drivers/index.xml create mode 100644 documentation/dtd/doc.dtd create mode 100644 documentation/dtd/references.dtd create mode 100644 documentation/dtd/xhtml-lat1.ent create mode 100644 documentation/dtd/xhtml-special.ent create mode 100644 documentation/dtd/xhtml-symbol.ent create mode 100644 documentation/lcd4linux/Makefile create mode 100644 documentation/lcd4linux/bug_report.xml create mode 100644 documentation/lcd4linux/example.xml create mode 100644 documentation/lcd4linux/index.xml create mode 100644 documentation/lcd4linux/write_doc.xml create mode 100644 documentation/plugins/Makefile create mode 100644 documentation/plugins/index.xml create mode 100644 documentation/xsl/body.xsl create mode 100644 documentation/xsl/doc.xsl create mode 100644 documentation/xsl/head.xsl create mode 100644 documentation/xsl/helpers.xsl create mode 100644 documentation/xsl/references.xsl create mode 100644 documentation/xsl/xhtml.xsl diff --git a/documentation/Makefile b/documentation/Makefile new file mode 100644 index 0000000..47425e4 --- /dev/null +++ b/documentation/Makefile @@ -0,0 +1,32 @@ +REP= lcd4linux drivers plugins + +default: makefiles html + true + +makefiles: + @for i in $(REP) ; do \ + (cd $$i && ln -sf ../Makefile.generic Makefile) ; \ + done + +cleanmakefiles: + @for i in $(REP) ; do \ + rm -f $$i/Makefile ; \ + done + +totalclean: + @for i in $(REP) ; do \ + (cd $$i && make clean ; rm Makefile) ; \ + done + rm -rf HTML + +#catalog: catalogue.xml xsl/catalogue.xsl +# test -d catalog || mkdir catalog +# xsltproc --param dir \'$(PWD)\' \ +# --param odir \'$(PWD)/catalog\' \ +# xsl/catalogue.xsl catalogue.xml >catalog/index.html +# cp charte/default/default.css catalog/ + +%: + @for i in $(REP) ; do \ + (cd $$i && make $@) ; \ + done diff --git a/documentation/Makefile.generic b/documentation/Makefile.generic new file mode 100644 index 0000000..2519f22 --- /dev/null +++ b/documentation/Makefile.generic @@ -0,0 +1,59 @@ +# 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/data/doc.css b/documentation/data/doc.css new file mode 100644 index 0000000..8a06636 --- /dev/null +++ b/documentation/data/doc.css @@ -0,0 +1,82 @@ +body { + margin: 0 10px 10px 10px; + padding: 0; +} + +h1 { + margin-left: -10px; + margin-top: 5px; + text-align: center; + border-bottom: 2px groove black; +} + +div.links { + float: right; + margin-left: 10px; + margin-top: 1em; + padding: 0 10px 0px 10px; + text-align: center; + border: 1px solid black; + background: white; +} div.links div.title { + background: white; + margin: -0.5em 10px 5px 10px; + padding: 0 10px; + float: center; + border: 1px solid black; +} div.links div.index { + position: relative; + bottom: 0; + left: -5px; + margin-top: 4px; + text-align: left; +} div.links a { + color: black; + /*text-decoration: none;*/ +} + +div.cmd { + background: #000; + border: 1px solid #ddd; + font-family: monospace,fixed; + font-style: bold; + color: #fff; + white-space: pre; + font-size: 12px; + padding: 5px; + margin: 5px; +} + +div.conf { + background: #eee; + border: 1px solid #111; + font-family: monospace,fixed; + white-space: pre; + font-size: 12px; + padding: 5px; + margin: 5px; +} + +div.warn { + margin-top: 20px; + border: 2px solid #700000; + margin-left: 20px; + padding-left: 5px; + width: auto; + min-height: 30px; +} + +div.note { + margin-top: 20px; + border: 2px solid #43607e; + margin-left: 20px; + padding-left: 5px; + width: auto; + min-height: 30px; +} + +img.icon { + float: left; + margin-left: -14px; + margin-top: -20px; +} diff --git a/documentation/data/images/note-icon.png b/documentation/data/images/note-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..33aa88b5efa86b5023277cd229062893d3cc5403 GIT binary patch literal 2288 zcmV zIRUZ&6z7`}=^}Pr0W{#3z@9BT?q$u|4kFV@`WLd`0H3Fti zG!#VBWCqWkd_*4Ltg5Lq``~H0o8SU*WnVd>8I5J7W z7dX{GQ~+Wc8g^!i15Z6#0Dca<1f)bZ>Vi<_6TG77&)@UF!)jYw8|TiCGB`4c@aup|g21%qdRp}BN8^JE*`N{5`?7V$53!@P}=;`NA`(Nkm`SCfR@lh)^ zKEUgL{rzcR7cdDVMNQcA&44V_=2siH?b^A1!%g&_A0?hhSEY;VI>g7vdHmrAx%0cX z5)KAX6osXWo4Iwbp3RNmrqmo=l>sJ7K zHg4Li^;SfVPIB}qb&6{6t~-}=Ula~$fL#$Dh3diCNKrW+=$%dY|04Xg%2fG*;Z z<^wLL}0QUf4L1SgU z05st4tFK+h$aoyfDppn%ACSm`MLhGjH!3|YU1|Z*43nnTHbi?81_B};sgW8e z?f&g+*59&w-G-a#JwJx+xDCtXhke5w?e4+QH5N5R$QLZ0JJ87s|L7|BA$VVDQ|zLJ zYg=Y~?4ur_7s!cvD60dt27t{guiZduCOh|p^&LjVqD5|I2FtRri$!e5W~jf9*Wc_y za$RIqrR}N}sH$3T-_Rw09`i;1S0@f17@{C zR%_^gdn6hqK0G;_;%Y5|qNx1w(LF40TT)e%qoE+Wrq&N$n5yd+4n|lef>$e1Uapb> z31~JAgM6V_m-}WYL?&0RJcGj%?A`YgCq6s}z?(-uU^nVjrE6-{a{wS#C=^iqdR<4uB}pQcNYJr%6&tQ!1Hj0{RDIt2{MuFl zRZ$VWkiVsN>m6hc(4S7HF?6*u_p1PL9f!=!40nEK%dE43;mL-0@AX^AXG&3y)Vlmv z0#It2y2nO`2pGoP0`r3L0m){wgo7qqH+9T9oJ!4<1y}PR6qe6r$Ys)qL#$Y>wXT){ z8#vU{{SJ|Eu;z~WyUBbm$EL4bhpuU}&T{!;O}h926|Fpl>kCer>BjYI>67^aQ|Lq6hL$E8IpiU;$4ad~PpIk-!|f zR0Cp~CaPMl&TUIt>NkM`NMdRnMb$WT;Aw!DedCsfYrqvBI0rm&=Dq)5=-OQFSLi0A zO-=L;jFdUMa`D27+4BQRCt_rh(@YHY0qh3`fV2ld!#A=Ljq<=FoqzxH$>L0`CIw1B zOvB*NyJxV9#aU-dS{8iV2UW>lE|X$ zQhknX51u~WxwWnR8bvq5^)Dz@=pqZXnI0b|86U@S91cGFnB_Y5@5JPK5{QclU7=d= z^9A6DiP^E<6GyHOhC(f>5k%8;R8?zOCX0nUsi|>dBZD}0k;&l!I$wFJPtc~z6MRxg zsQpO>TmJE40Ehrhz|Vl)H*LR*g^SxT%n)WEgl3qinuaVZxVSiWk)l5y=*3K@4Kb^Uin+}_!1mSazSeZb@-+m45hPj0bsVG% zMS!BH7v2f7X@>hwar*e%32{ihETl3i03<)F>2#&{fq(!K7PcAKDDJS!#7#;Q`kfSA zWv}RM4vQVm2$@WO9`6H{UTAcYk$^B${A~EHfTbELilWSUT7>N9`9f3ejZE{H?z_W! z?-)f7h)ecHR%rkrdBDh?F`yrS>j~CB|93AofG_kr@#S@?*Z%?BoK~b*_Q>_|s`b8H{~|Ih6_&vOF*AOGEeN|kkNl=0t%qD!E;svOh!WoB0w1WdZ6t?I0lRZli6xR%L2UmIFzo3qZW8feq$1d z3b87}5t3P30Sn~Vpt&6SJD^Y<%Jgii(P`*=#6^ zGUv3p-7IfvVz{e|=-?m|V`FIXIEsO`><+NB!6KTg z-@F-*$AhY>X~E00Y~x1q%gVTR`ZVJsBUsF^2KA-T`z?Gch1jeKn4xl?)v!+xyH5K3 zY<~G=LTlELo12?4aCzpJl`%CwPVa>a#G+9wLNIn%qr=BNFqnxZv^3z=$6>t-elI)h z2(YrPjoN$e!Rz&A1>T$`_4Pyt2Ix6|o_H*V#Rx;r5~w>1M?_>cNi2wf3RpM5#|q?` zizC2Ko_vz^k3PzhB}?W6wtxSAUVr^{4j(?u)vH&judh$}IaO8hheGt6Jb>F*GzpV`JkC;O4X4?IuuB!R3!WB04;bCXm{pb{szFgMoDZpr#`50F*gkuemTK zLS5tT-2?&w91h2v((mZ#pufMLlP6Eo(a}L95@G-T{R!ZyoV~ERnpLf>xV&BfT*78* zVIPnWIE@2*egX=h1>hNZaRjJ%-~o!4FURlqr+3c$d@fzO#L&>t%paO3N;N$DEP)j( zP%Q>dy8&*+-LL`36-!$3*_BK{-411T_>FwzI|Bh4ckQB}pdc-XzP>&bMIjoE&XUyi z>(|qM7huz#J$On=Kv8fAQ!0gBz->YcX$dHRwgjF|&T*=D?7-!6r8ONzQ79@ZA`*!Z z4u@wE2nK`mMx~;aD=Dn3B**7N5vF8;AFYM;k``tZOKOtzm&wwP0d~KiRV^*}e7<=B z0N8A{)Nwh((7NvFr?KVa7<&nkmm4PSk$hnm0R>R~@Syyo<3L4oGkJM=^Ge^e@lYs) z+wGnKzP7eDV*)LJ%;`D4_w1&3H3W8kSU5QBYPk zBU#HN;{@2UWeZNH6PwLOTU%RJdD5LtO;{X`ghN|^g6T8CG$Ta?)FvoZp-6V#(v2Gv zjys>!lV?jy3)R)tY~8w*ojZ4Co$M`Jw~id)3pNA!YC*s$6r)%GH2~{m^N9l$_uh-o z=R;N1tlAa_4jjn7Un4Ym$EHpE^VBI6RmCdm>APX;r|<{CDXIdRT`E>$Ku#clr?@y# z*Zxp5S<}_`-%l(W#hIU<(1O(nG^QVDDxhjosTczSRaIFRDxIC3y!hga+;`u7w6?a= z-rl}o;PPC)X;UIUvKaQWLIfropjiM-Ps)h`6%}|qo*A(`)A8DCuhHGzO?!Jg!^6Y$ z_V#l8`0=!+l5V&IfrJ^WhIy;Pi4z1=T{@a$Kz=ZY)9K8Lz^PNG=LA zDfh{A?_f<0U%&l!qIhvbiO7j;fNB90Jt@PxcJ5r(&RbGaLU(s};_rrrh8bWNDij4! zH7)V%G%7?hC(>rM!7ad*bLWV~Vp;jX-o1MXg+dANufFsu9)_=7u-QzWZnU>^^3WlE{_w*KmRMzFB_~dt$Xepb4Z@?7+z6%%>ElC{0^n<|C?eNr6_*q6bBsLpXrxUBwNqlN5v(Tuj#3v`2 z2#1M{kAoCtVj`KG5dJsX3=7r5=K^9Tm(O^goZny!7g>@ z7ITvTxkWF=oF1{3 z132%5au0ZyK#2n0Nzgn{;4t1#Nx(eU`wja=1-%P8ED-zLFprqvG%gx}qXPUbLm>!XHGb_W4atASIiu-=9Kag$MoG@;)F~-;p0-9d`hyMn6R9Q>2r#Rko>3s zJSsp(1i6@eA*iIean}Sen*i$&z#U@RB@#A4z?|wFd&ed4lS$ymh1o;}So3*8>QK+> zQY#t!>wqfA$N;SpXln}a=?KInzmXjr7DJj + + + + + + + index + + + + + + overview + + + + + bug_report + + + + + contact + + + + + write_doc + + + + + + example + + + + + + drivers + index + + + + + drivers + hd44780 + + + + + + plugins + index + + + + + plugins + i2c_sensors + + + + diff --git a/documentation/drivers/Makefile b/documentation/drivers/Makefile new file mode 100644 index 0000000..2519f22 --- /dev/null +++ b/documentation/drivers/Makefile @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000..12ba14e --- /dev/null +++ b/documentation/drivers/index.xml @@ -0,0 +1,14 @@ + + + + + + &L4L; drivers + drivers_index + + + +

Drivers

+ + + diff --git a/documentation/dtd/doc.dtd b/documentation/dtd/doc.dtd new file mode 100644 index 0000000..3b1a778 --- /dev/null +++ b/documentation/dtd/doc.dtd @@ -0,0 +1,910 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +%HTMLlat1; + + +%HTMLsymbol; + + +%HTMLspecial; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/dtd/references.dtd b/documentation/dtd/references.dtd new file mode 100644 index 0000000..fc54fde --- /dev/null +++ b/documentation/dtd/references.dtd @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + diff --git a/documentation/dtd/xhtml-lat1.ent b/documentation/dtd/xhtml-lat1.ent new file mode 100644 index 0000000..293d2ba --- /dev/null +++ b/documentation/dtd/xhtml-lat1.ent @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/dtd/xhtml-special.ent b/documentation/dtd/xhtml-special.ent new file mode 100644 index 0000000..fefb15d --- /dev/null +++ b/documentation/dtd/xhtml-special.ent @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/dtd/xhtml-symbol.ent b/documentation/dtd/xhtml-symbol.ent new file mode 100644 index 0000000..e950aad --- /dev/null +++ b/documentation/dtd/xhtml-symbol.ent @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/lcd4linux/Makefile b/documentation/lcd4linux/Makefile new file mode 100644 index 0000000..2519f22 --- /dev/null +++ b/documentation/lcd4linux/Makefile @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000..49bf743 --- /dev/null +++ b/documentation/lcd4linux/bug_report.xml @@ -0,0 +1,32 @@ + + + + + + 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

+
    +
  • Your display doesn't want to work, prints strange things or keeps blank ?
    • +
  • You can't get a plugin to work, there are ???? or **** where you wanted to display the temperature ?
    • +
  • You noticed a strange behavior from &l4l; or a plugin ?
    • +
+You should contact the lcd4linux-users maillist, and post a detailled report containing at least : +
    +
  • the &l4l; version you use.
    • +
  • a description of what happens
    • +
  • if relevant, a description of your display (especially for HD44780-based displays)
    • +
  • a log of &l4l; output ( lcd4linux -vvv > log )
    • +
  • a copy of your lcd4linux.conf file
    • +
+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 new file mode 100644 index 0000000..63702e0 --- /dev/null +++ b/documentation/lcd4linux/example.xml @@ -0,0 +1,50 @@ + + + + + + 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 new file mode 100644 index 0000000..93f75eb --- /dev/null +++ b/documentation/lcd4linux/index.xml @@ -0,0 +1,17 @@ + + + + + + &L4L; documentation index + index + + +

&L4L;

+ +

Drivers

+ +

Plugins

+ + + diff --git a/documentation/lcd4linux/write_doc.xml b/documentation/lcd4linux/write_doc.xml new file mode 100644 index 0000000..b8d243d --- /dev/null +++ b/documentation/lcd4linux/write_doc.xml @@ -0,0 +1,102 @@ + + + + + + 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 new file mode 100644 index 0000000..2519f22 --- /dev/null +++ b/documentation/plugins/Makefile @@ -0,0 +1,59 @@ +# 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 new file mode 100644 index 0000000..8e803ae --- /dev/null +++ b/documentation/plugins/index.xml @@ -0,0 +1,14 @@ + + + + + + &L4L; plugins + plugins_index + + + +

    Plugins

    + + +     diff --git a/documentation/xsl/body.xsl b/documentation/xsl/body.xsl new file mode 100644 index 0000000..8b13ebd --- /dev/null +++ b/documentation/xsl/body.xsl @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + diff --git a/documentation/xsl/doc.xsl b/documentation/xsl/doc.xsl new file mode 100644 index 0000000..1a2045f --- /dev/null +++ b/documentation/xsl/doc.xsl @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/xsl/head.xsl b/documentation/xsl/head.xsl new file mode 100644 index 0000000..7d975dd --- /dev/null +++ b/documentation/xsl/head.xsl @@ -0,0 +1,68 @@ + + + + + + + + + + + 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 new file mode 100644 index 0000000..df91a4a --- /dev/null +++ b/documentation/xsl/helpers.xsl @@ -0,0 +1,141 @@ + + + + + + + + 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 new file mode 100644 index 0000000..4dc47f6 --- /dev/null +++ b/documentation/xsl/references.xsl @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/documentation/xsl/xhtml.xsl b/documentation/xsl/xhtml.xsl new file mode 100644 index 0000000..1f5cb98 --- /dev/null +++ b/documentation/xsl/xhtml.xsl @@ -0,0 +1,16 @@ + + + + + + + + + + + + -- 2.39.5