lazarus

mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 11:18:10 +02:00

History

maxim 5131a93bc0 Merged revision(s) 55971 #d6b6fe9b4b from trunk: wiki: Fix compilation of wikiget ........ git-svn-id: branches/fixes_1_8@55981 -		2017-10-05 22:36:58 +00:00
..
css	wiki: single css folder to avoid three equal wiki.css files.	2015-06-25 17:11:53 +00:00
images/internal	wiki: Move template icons to separate directory to protect them from option "--deletenotusedimages"	2015-06-17 08:43:32 +00:00
lazwiki	Copy AVL_Tree from FPC trunk and replace classes in AvgLvlTree and in CodetoolsStructs with it.	2017-04-05 08:34:48 +00:00
test	Fix compilation of Codetools examples and wiki test project. Clean uses sections.	2017-04-07 19:02:11 +00:00
myfphttpclient.pp
parsewikipage.lpi	Wiki component: Support prefix "file:" in wikiget and HTML converter. Issue #28265 , patch from wp.	2015-06-10 14:35:14 +00:00
parsewikipage.lpr
README.txt	wiki: Fix operation of language links. Update README.txt.	2015-06-27 14:27:26 +00:00
wikiconvert.lpi
wikiconvert.lpr	general: Updated address of the Free Software Foundation in copyright messages	2017-01-29 21:04:32 +00:00
wikiget.lpi
wikiget.lpr	Merged revision(s) 55971 #d6b6fe9b4b from trunk:	2017-10-05 22:36:58 +00:00

README.txt

BEWARE: This is all work in progress.

UNDER CONSTRUCTION

This directory contains tools to create the offline help of the wiki.

Downloading the wiki:

Compile wikiget.lpi

Download all pages and images:
./wikiget --allmissing

Download changes of last 2 days
./wikiget --recent=2 --deletenotusedpages --deletenotusedimages

Note: you can stop/kill the tool at any time and run it again. It will download
only the missing files.
See ./wikiget -h for all options.


Creating XHTML pages:
./wikiconvert --format=xhtml --css=css/wiki.css 'wikixml/*.xml'


Creating HTML pages:
./wikiconvert --format=html --css=css/wiki.css 'wikixml/*.xml'


Creating chm:
./wikiconvert --format=chm --css=css/wiki.css wikixml/Lazarus_Documentation.g400.xml 'wikixml/*.xml'


ToDos
ToDos wiki parser: see wikiparser.pas

ToDos iphtml:
-too big space between paragraphs
-background for pre
-slow on some pages (e.g. lazarus_documentation)

Todos: convert to fpdoc
 ./wikiconvert --format=fpdoc --outputdir=fpdocxml wikixml/1-dimensional_arrays.0000.xml
 cd fpdochtml/
 fpdoc --format=html --charset=UTF8 --image-url=../images --package=wiki --descr=../fpdocxml/1-dimensional_arrays.0000.xml --verbose
ToDo: find out why fpdoc does not use the description.