lazarus-ccr

History

wp_xxyyzz 7b43bd5894 FPSpreadsheet: Improved presentation of date axis in chart. Testing to build documentation. git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@9448 8e941d3f-bd1b-0410-a28a-d453659cc2b4		2024-09-18 17:57:40 +00:00
..
api	FPSpreadsheet: Improved presentation of date axis in chart. Testing to build documentation.	2024-09-18 17:57:40 +00:00
wiki	FPSpreadsheet: Improved presentation of date axis in chart. Testing to build documentation.	2024-09-18 17:57:40 +00:00
fpspreadsheet-api.chm	FPSpreadsheet: Improved presentation of date axis in chart. Testing to build documentation.	2024-09-18 17:57:40 +00:00
fpspreadsheet-wiki.chm	FPSpreadsheet: Improved presentation of date axis in chart. Testing to build documentation.	2024-09-18 17:57:40 +00:00
README.txt	fpspreadsheet: Prepare for new release v1.12: Remove chart support. Set version number to 1.12. Update help files.	2020-06-02 11:50:30 +00:00

README.txt

--------------------------------------------------------------------------------
  Contents of this folder
--------------------------------------------------------------------------------

- fpsspreadsheet-wiki.chm is a snapshot of the wiki articles covering 
  fpspreadsheet.

- fpspreadsheet-api.chm contains the documentation of the most important
  procedures and functions of the library. It is extracted from the embedded
  comments in the source files.
  
  
--------------------------------------------------------------------------------
  How to create fpspreadsheet-wiki
--------------------------------------------------------------------------------
- Navigate to the folder components/wiki of the Lazarus installation.

- Compile the package "lazwiki" in the equally-named subfolder.

- Compile the programs "wikiget" and "wikiconvert".

- Add them to the system's search path (or copy the two executables to the
  folder docs/wiki of the fpspreadsheet installation.

- You also have to copy the OpenSSL DLLs libeay32.dll and ssleay32.dll of the
  correct bitness to the folder docs/wiki of the fpspreadsheed installation.
  
- Run the script "make_docs.bat" (no Linux script at the moment)

- This script downloads the current fpspreadsheet wiki articles and creates
  a chm help file. 
  
  
--------------------------------------------------------------------------------
  How to create fpspreadsheet-api (Windows-only)
--------------------------------------------------------------------------------
- Download the program "Doc-o-matic Express" from the site
  http://www.doc-o-matic.com/download.shtml

- This is a source code documentation and help authoring tool which constructs
  a chm help file from comments embedded into the source code.

- Install the program

- Change the variable DOX_CMD in the batch file "builddoc.bat" to point to the 
  correct folder.

- Run the batch file "builddoc.bat" which extracts the documentation code from
  the sources and creates the chm file. It may take some time...
  
  
--------------------------------------------------------------------------------