Menu
▾
▴
[Docutils-checkins] sandbox/ax-/chm README.txt,1.1.1.1,1.2 rst.chm,1.3,1.4 rst.hhc,1.1.1.1,1.2 rst.hhp,1.1.1.1,1.2
|
From: Axel K. <ax...@us...> - 2003-08-24 02:27:39
|
Update of /cvsroot/docutils/sandbox/ax-/chm In directory sc8-pr-cvs1:/tmp/cvs-serv24698 Modified Files: README.txt rst.chm rst.hhc rst.hhp Log Message: used Ollie Rutherfurd's lovely rst2chm <http://www.rutherfurd.net/software/rst2chm/> for a complete chm doc. see README.{txt|html} for details. Index: README.txt =================================================================== RCS file: /cvsroot/docutils/sandbox/ax-/chm/README.txt,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -u -d -r1.1.1.1 -r1.2 --- README.txt 2 Jul 2003 17:51:06 -0000 1.1.1.1 +++ README.txt 24 Aug 2003 02:27:35 -0000 1.2 @@ -1,19 +1,26 @@ -From: "Axel Kollmorgen" <axel at kollmorgen dot net> -To: <docutils-users at lists dot sourceforge dot net>; <doc-sig at python dot org> -Subject: docutils (rst) User Documentation in Microsoft HTML Help (chm) format -Date: Dienstag, 1. Juli 2003 16:35 +docutils documentation in Microsoft HTML Help (chm) format +========================================================== -hi all, +:Author: Axel Kollmorgen +:Contact: axel(at)kollmorgen[dot]net +:Date: $Date$ +:Web site: http://docutils.sourceforge.net/sandbox/ax-/chm/ -i just converted a big part of the docutils (rst) User Documentation -(Intro, Primer, Quick rst, spec, FAQ, ...) into chm format. this is -quite handy (for people who can use chm ;)) - it's all in one place, -with a single toc, and fully searchable. +this is the complete docutils_ documentation - all \*.txt files and +`docs/rst/quickref.html`_ - in a single, toc'ed, and full-text searchable +chm file. the `first version`_ was handmade (and incomplete). the +current version uses Ollie Rutherfurd's lovely rst2chm_:: -this sandbox contains the chm plus the HTML Help project (.hhp) and toc -(.hhc) files. + rst2chm.py --title=reStructuredText --default-topic=spec\rst\introduction.html + --no-clean rst.chm + spec\rst\*.txt docs\rst\*.txt docs\*.txt *.txt spec\*.txt spec\howto\*.txt -for future versions, i'll try one of the rst-to-docbook converters and -the docbook chm writer to automatically generate a complete -documentation. current version doesn't include all documentation and -doesn't link all toc entries to their subheadings properly. +and a few manual improvements (inclusion and "sectioning" of +`docs/rst/quickref.html`_, some rearrangements of toc entries, and an +improved stylesheet) (and is complete). and probably won't see an update +any soon. + +.. _docutils: http://docutils.sourceforge.net/ +.. _docs/rst/quickref.html: http://docutils.sourceforge.net/docs/rst/quickref.html +.. _first version: http://mail.python.org/pipermail/doc-sig/2003-July/003033.html +.. _rst2chm: http://www.rutherfurd.net/software/rst2chm/ Index: rst.chm =================================================================== RCS file: /cvsroot/docutils/sandbox/ax-/chm/rst.chm,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 Binary files /tmp/cvsAAr4pu and /tmp/cvsI5ToUR differ Index: rst.hhc =================================================================== RCS file: /cvsroot/docutils/sandbox/ax-/chm/rst.hhc,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -u -d -r1.1.1.1 -r1.2 --- rst.hhc 2 Jul 2003 17:51:06 -0000 1.1.1.1 +++ rst.hhc 24 Aug 2003 02:27:36 -0000 1.2 @@ -3,2300 +3,2946 @@ <HEAD> <meta name="GENERATOR" content="Microsoft® HTML Help Workshop 4.1"> <!-- Sitemap 1.0 --> -</HEAD><BODY> -<OBJECT type="text/site properties"> - <param name="Auto Generated" value="Yes"> -</OBJECT> -<UL> - <LI> <OBJECT type="text/sitemap"> - <param name="Name" value="An Introduction to reStructuredText"> - <param name="Local" value="spec/rst/introduction.html"> [...5212 lines suppressed...] + <param name="Local" value="spec/howto/rst-directives.html#examples"> + </OBJECT> + <UL> + <LI><OBJECT type="text/sitemap"> + <param name="Name" value="Admonitions"> + <param name="Local" value="spec/howto/rst-directives.html#admonitions"> + </OBJECT> + <LI><OBJECT type="text/sitemap"> + <param name="Name" value=""image""> + <param name="Local" value="spec/howto/rst-directives.html#image"> + </OBJECT> + <LI><OBJECT type="text/sitemap"> + <param name="Name" value=""contents""> + <param name="Local" value="spec/howto/rst-directives.html#contents"> + </OBJECT> + </UL> + </UL> + </UL> +</BODY> +</HTML> Index: rst.hhp =================================================================== RCS file: /cvsroot/docutils/sandbox/ax-/chm/rst.hhp,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -u -d -r1.1.1.1 -r1.2 --- rst.hhp 2 Jul 2003 17:51:06 -0000 1.1.1.1 +++ rst.hhp 24 Aug 2003 02:27:36 -0000 1.2 @@ -1,26 +1,50 @@ + +[INFOTYPES] + [OPTIONS] Compatibility=1.1 or later -Compiled file=rst.chm -Contents file=rst.hhc -Default topic=spec\rst\introduction.html -Display compile progress=No +Compiled File=rst.chm +Contents File=rst.hhc +Default Topic=spec\rst\introduction.html +Display compile progress=Yes Full-text search=Yes -Language=0x409 English (United States) +Language=0x0409 English (United States) Title=reStructuredText +Binary TOC=No +Binary Index=Yes +Index File= +Default Window= +Default Font=Tahoma, 8 +Auto Index=No +Create CHI file=No +Error log file=_errorlog.txt +[WINDOWS] [FILES] -docs\rst\quickstart.html -docs\rst\quickref.html -spec\rst\reStructuredText.html -spec\rst\alternatives.html -spec\rst\directives.html -spec\rst\interpreted.html -spec\rst\introduction.html -spec\rst\problems.html -docs\tools.html -docs\latex.html +COPYING.html FAQ.html +HISTORY.html +README.html +docs/latex.html +docs/tools.html +docs/rst/quickstart.html +spec/doctree.html +spec/notes.html +spec/pep-0256.html +spec/pep-0257.html +spec/pep-0258.html +spec/pep-0287.html +spec/pysource.html +spec/semantics.html +spec/transforms.html +spec/howto/i18n.html +spec/howto/rst-directives.html +spec/rst/alternatives.html +spec/rst/directives.html +spec/rst/interpreted.html +spec/rst/introduction.html +spec/rst/problems.html +spec/rst/reStructuredText.html -[INFOTYPES] - +[MERGE FILES] |