Renames the doc building scripts and adds some more scripts for Windows.

git-svn-id: trunk@14962 -
This commit is contained in:
sekelsenmat 2008-04-25 10:52:13 +00:00
parent 420b847eee
commit 95bf12f9c6
7 changed files with 97 additions and 4 deletions

8
.gitattributes vendored
View File

@ -1339,14 +1339,16 @@ docs/acknowledgements.txt svneol=native#text/plain
docs/booth/ProdProgEntwMitOpenSourceSystems2007.odp -text docs/booth/ProdProgEntwMitOpenSourceSystems2007.odp -text
docs/contributors.utf8 svneol=native#text/plain docs/contributors.utf8 svneol=native#text/plain
docs/html/README.txt svneol=native#text/plain docs/html/README.txt svneol=native#text/plain
docs/html/build_gtkintf_html.sh -text svneol=native#application/x-sh
docs/html/build_html.bat svneol=native#text/plain
docs/html/build_html.sh -text svneol=native#application/x-sh
docs/html/build_lcl_docs.lpi svneol=native#text/plain
docs/html/build_lcl_docs.lpr svneol=native#text/plain
docs/html/fpdoc.css svneol=native#text/css docs/html/fpdoc.css svneol=native#text/css
docs/html/localfclfooter.xml svneol=native#text/plain docs/html/localfclfooter.xml svneol=native#text/plain
docs/html/locallclfooter.xml svneol=native#text/plain docs/html/locallclfooter.xml svneol=native#text/plain
docs/html/localrtlfooter.xml svneol=native#text/plain docs/html/localrtlfooter.xml svneol=native#text/plain
docs/html/sourceforgefooter.xml svneol=native#text/xml docs/html/sourceforgefooter.xml svneol=native#text/xml
docs/html/update_gtkintf_html.sh -text svneol=native#application/x-sh
docs/html/update_html.sh -text svneol=native#application/x-sh
docs/html/update_lcl_docs.lpr -text
docs/html/update_lcl_html.sh -text svneol=native#mime-type%3Dtext/plain docs/html/update_lcl_html.sh -text svneol=native#mime-type%3Dtext/plain
docs/images/laztitle.png -text docs/images/laztitle.png -text
docs/images/laztitle.svg -text svneol=native#image/svg%2Bxml docs/images/laztitle.svg -text svneol=native#image/svg%2Bxml

View File

@ -4,7 +4,11 @@ HTML documentation of Lazarus
This directory contains the tools to create the HTML documentation for lazarus. This directory contains the tools to create the HTML documentation for lazarus.
The documentation is stored in fpdoc format in the docs/xml/ directory. The documentation is stored in fpdoc format in the docs/xml/ directory.
The script update_html.sh will automatically create the whole HTML For UNIXes:
The script build_html.sh will automatically create the whole HTML
documentation. documentation.
For Windows:
Build the project build_lcl_docs.lpi, fix the PATH in the build_html.bat batch script to your local instalation and then run the script, or run build_lcl_docs.exe directly.

11
docs/html/build_html.bat Normal file
View File

@ -0,0 +1,11 @@
REM
REM Builds all Lazarus docs
REM
REM Notes:
REM
REM 1 - Please fix the path in this file for your installation
REM 2 - Before running this file, first compile the project build_lcl_docs.lpi
REM
PATH=C:\Programas\lazarus22\fpc\2.2.0\bin\i386-win32
build_lcl_docs.exe
pause

View File

@ -0,0 +1,76 @@
<?xml version="1.0"?>
<CONFIG>
<ProjectOptions>
<PathDelim Value="\"/>
<Version Value="6"/>
<General>
<MainUnit Value="0"/>
<TargetFileExt Value=".exe"/>
<Title Value="build_lcl_docs"/>
<ActiveEditorIndexAtStart Value="0"/>
</General>
<VersionInfo>
<ProjectVersion Value=""/>
<Language Value=""/>
<CharSet Value=""/>
</VersionInfo>
<PublishOptions>
<Version Value="2"/>
<IgnoreBinaries Value="False"/>
<IncludeFileFilter Value="*.(pas|pp|inc|lfm|lpr|lrs|lpi|lpk|sh|xml)"/>
<ExcludeFileFilter Value="*.(bak|ppu|ppw|o|so);*~;backup"/>
</PublishOptions>
<RunParams>
<local>
<FormatVersion Value="1"/>
<LaunchingApplication PathPlusParams="/usr/X11R6/bin/xterm -T 'Lazarus Run Output' -e $(LazarusDir)/tools/runwait.sh $(TargetCmdLine)"/>
</local>
</RunParams>
<Units Count="1">
<Unit0>
<Filename Value="build_lcl_docs.lpr"/>
<IsPartOfProject Value="True"/>
<UnitName Value="build_lcl_docs"/>
<CursorPos X="19" Y="258"/>
<TopLine Value="231"/>
<EditorIndex Value="0"/>
<UsageCount Value="20"/>
<Loaded Value="True"/>
</Unit0>
</Units>
<JumpHistory Count="3" HistoryIndex="2">
<Position1>
<Filename Value="build_lcl_docs.lpr"/>
<Caret Line="10" Column="1" TopLine="1"/>
</Position1>
<Position2>
<Filename Value="build_lcl_docs.lpr"/>
<Caret Line="168" Column="12" TopLine="144"/>
</Position2>
<Position3>
<Filename Value="build_lcl_docs.lpr"/>
<Caret Line="11" Column="6" TopLine="1"/>
</Position3>
</JumpHistory>
</ProjectOptions>
<CompilerOptions>
<Version Value="5"/>
<PathDelim Value="\"/>
<CodeGeneration>
<Generate Value="Faster"/>
</CodeGeneration>
<Other>
<CompilerPath Value="$(CompPath)"/>
</Other>
</CompilerOptions>
<Debugging>
<Exceptions Count="2">
<Item1>
<Name Value="ECodetoolError"/>
</Item1>
<Item2>
<Name Value="EFOpenError"/>
</Item2>
</Exceptions>
</Debugging>
</CONFIG>