pascal/lazarus-ccr
1
0
Fork 0
Code Issues Releases Activity

fpspreadsheet: Update help files for v1.14. Add instructions how to build them.

Browse Source 
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@8193 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
wp_xxyyzz
2022-01-31 11:32:56 +00:00
parent e028bf3a27
commit 27b1f3af8c
5 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
components/fpspreadsheet/docs/api/instructions.txt Normal file
View File

@ -0,0 +1,8 @@
--------------------------------------------------------------------------------
Instructions how to create the api documentation chm help file for fpspreadsheet
--------------------------------------------------------------------------------
* Download pasdoc (https://github.com/pasdoc/pasdoc).
* Compile the pasdoc binary.
* Run the builddoc batch file.
* Run the make_chm batch file.

BIN
components/fpspreadsheet/docs/fpspreadsheet-api.chm
View File

Binary file not shown.

BIN
components/fpspreadsheet/docs/fpspreadsheet-wiki.chm
View File

Binary file not shown.

13
components/fpspreadsheet/docs/wiki/instructions.txt Normal file
View File

@ -0,0 +1,13 @@
--------------------------------------------------------------------------------
Instructions how to create a chm file from the fpspreadsheet wiki pages
--------------------------------------------------------------------------------
- Compile the console applications wikiget and wikiconvert.
- Note: wikiconvert works correctly only in Laz 2.0.8/fpc3.0.4.
In later versions the contents page is not created correctly
(tested up to Laz 2.2/fpc3.2.2
- Copy the created exe files into this directory.
- Run the make_docs batch file.

4
components/fpspreadsheet/docs/wiki/make_docs.bat
View File

@ -10,5 +10,7 @@ wikiget --page=TsWorksheetGrid --page=TsWorksheetChartSource
echo. echo.
echo Converting wiki to chm... echo Converting wiki to chm...
wikiconvert --format=%FMT% --css=css/wiki.css --root="FPSpreadsheet wiki pages" --title="FPSpreadsheet wiki pages (offline version, created %DATE%)" --chm="..\fpspreadsheet-wiki.chm" wikixml/FPSpreadsheet.s00.xml wikixml/FPSpreadsheet=3A_Examples*.xml wikixml/FPSpreadsheet=3A_List_of_formulas*.xml wikixml/RPN_Formulas*.xml wikixml/FPSpreadsheet_tutorial=3A_Writing*.xml wikixml/TsWorksheet*.xml
wikiconvert --format=%FMT% --css=css/wiki.css --root="FPSpreadsheet wiki pages" --title="FPSpreadsheet wiki pages (offline version, created %DATE%)" --chm="..\fpspreadsheet-wiki.chm" wikixml/FPSpreadsheet.s00.xml wikixml/FPSpreadsheet=3A_Examples.s0300.xml wikixml/FPSpreadsheet=3A_List_of_formulas.s03000.xml wikixml/RPN_Formulas_in_FPSpreadsheet.u03g00.xml wikixml/FPSpreadsheet_tutorial=3A_Writing_a_mini_spreadsheet_application.s000c0000000.xml wikixml/TsWorksheetGrid.k08.xml
set FMT= set FMT=