diff --git a/components/fpspreadsheet/docs/api/instructions.txt b/components/fpspreadsheet/docs/api/instructions.txt new file mode 100644 index 000000000..52473e5d5 --- /dev/null +++ b/components/fpspreadsheet/docs/api/instructions.txt @@ -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. diff --git a/components/fpspreadsheet/docs/fpspreadsheet-api.chm b/components/fpspreadsheet/docs/fpspreadsheet-api.chm index ae6ed8a9d..054058991 100644 Binary files a/components/fpspreadsheet/docs/fpspreadsheet-api.chm and b/components/fpspreadsheet/docs/fpspreadsheet-api.chm differ diff --git a/components/fpspreadsheet/docs/fpspreadsheet-wiki.chm b/components/fpspreadsheet/docs/fpspreadsheet-wiki.chm index b8596bb0b..efc53116e 100644 Binary files a/components/fpspreadsheet/docs/fpspreadsheet-wiki.chm and b/components/fpspreadsheet/docs/fpspreadsheet-wiki.chm differ diff --git a/components/fpspreadsheet/docs/wiki/instructions.txt b/components/fpspreadsheet/docs/wiki/instructions.txt new file mode 100644 index 000000000..8e2dc3e84 --- /dev/null +++ b/components/fpspreadsheet/docs/wiki/instructions.txt @@ -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. diff --git a/components/fpspreadsheet/docs/wiki/make_docs.bat b/components/fpspreadsheet/docs/wiki/make_docs.bat index 466116199..f8d086fa1 100644 --- a/components/fpspreadsheet/docs/wiki/make_docs.bat +++ b/components/fpspreadsheet/docs/wiki/make_docs.bat @@ -10,5 +10,7 @@ wikiget --page=TsWorksheetGrid --page=TsWorksheetChartSource echo. 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= \ No newline at end of file