fpspreadsheet: Add a new chm help file containing snapshots of the fpspreadsheet wiki articles. Move current fpspreadsheet.chm into a docs subfolder and rename it to fpspreadsheet-api.chm. Add/update scripts and tools for creation of these chm files.

git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@4194 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
wp_xxyyzz
2015-06-27 19:40:42 +00:00
parent de6c82440d
commit 65c59aa927
10 changed files with 448 additions and 32 deletions

View File

@ -1,2 +0,0 @@
"C:\Program Files\Doc-O-Matic 6 Express\domexpress.exe" -config "HTML Help" fpspreadsheet.dox-express
pause

View File

@ -0,0 +1,46 @@
--------------------------------------------------------------------------------
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.
- 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
- Run the batch file "builddoc.bat" which extracts the documentation code from
the sources and creates the chm file.
--------------------------------------------------------------------------------

View File

@ -0,0 +1,25 @@
@echo off
set DOX_CMD="D:\Programme\Doc-O-Matic 7 Express\domexpress.exe"
if not exist output mkdir output
rem Prepare files...
path=%PROGRAMFILES%;%PATH%
pushd .
cd ..\..
ren fps.inc ---fps.inc
ren fpspreadsheetctrls.lrs ---fpspreadsheetctrls.lrs
popd
rem Extract help topics and create chm files...
%DOX_CMD% -config "HTML Help" fpspreadsheet.dox-express > doc-o-matic.txt
rem Clean up
pushd .
cd ..\..
chdir
ren ---fps.inc fps.inc
ren ---fpspreadsheetctrls.lrs fpspreadsheetctrls.lrs
popd
if exist output\fpspreadsheet.chm copy output\fpspreadsheet.chm ..\fpspreadsheet-api.chm /y

View File

@ -1,8 +1,8 @@
; This is a Doc-O-Matic version 6.4.2.1326 project file.
; This is a Doc-O-Matic version 7.0.1.1645 project file.
; This file is maintained by Doc-O-Matic, do not edit manually.
[AutoTexts]
Empty=0
Empty=1
Saved=1
Text0=This is unknown %SYMBOLNAME%.
Text1=This is class %SYMBOLNAME%.
@ -29,15 +29,16 @@ Name2=Help 2
[Configurations\Help 2\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\AdditionalFiles]
Count=4
File0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_titlebkg.jpg
File0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_titlebkg.jpg
[Configurations\Help 2\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\General]
ClearDirectoryBeforeExport=0
HelpKind=2
OutputDir=output
OutputXHTML=0
TargetBOM=1
TargetCodepage=utf-8
@ -64,6 +65,14 @@ Help2PluginNamespace=0
Help2PluginNamespaceName=MS.VSIPCC+
Help2RegisterType=0
Help2UnregisterNamespace=1
Help3BookName=
Help3Catalog=vs
Help3Locale=en-us
Help3PackageFilename=
Help3Product=MyProduct
Help3ProductVersion=100
Help3RegisterBook=1
Help3Vendor=MyCompany
HelpCompiler=
HTMLHelp2Filename=
HTMLHelpDisplayFontScaleButton=0
@ -77,8 +86,8 @@ WindowPosition_Top=0
[Configurations\Help 2\Image Paths]
Count=2
Path0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics
Path1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\en
Path0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics
Path1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\en
[Configurations\Help 2\Output Options]
ClassHierarchyLayoutOutputDir=output
@ -88,17 +97,18 @@ ID={D3A588E0-9472-11D3-BDD1-0080C8BA053D}
[Configurations\HTML Help\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\AdditionalFiles]
Count=4
File0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_titlebkg.jpg
File0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_titlebkg.jpg
[Configurations\HTML Help\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\General]
ClearDirectoryBeforeExport=0
HelpKind=1
OutputDir=output
OutputXHTML=0
TargetBOM=0
TargetCodepage=windows-1252
TargetCodepage=utf-8
[Configurations\HTML Help\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\General Build Options]
ShowDocumentation=1
@ -123,7 +133,15 @@ Help2PluginNamespace=0
Help2PluginNamespaceName=MS.VSIPCC+
Help2RegisterType=0
Help2UnregisterNamespace=1
HelpCompiler=C:\Program Files\HTML Help Workshop\hhc.exe
Help3BookName=
Help3Catalog=vs
Help3Locale=en-us
Help3PackageFilename=
Help3Product=MyProduct
Help3ProductVersion=100
Help3RegisterBook=1
Help3Vendor=MyCompany
HelpCompiler=C:\Program Files (X86)\HTML Help Workshop\hhc.exe
HTMLHelp2Filename=
HTMLHelpDisplayFontScaleButton=0
HTMLHelpFilename=
@ -136,8 +154,8 @@ WindowPosition_Top=0
[Configurations\HTML Help\Image Paths]
Count=2
Path0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics
Path1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\en
Path0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics
Path1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\en
[Configurations\HTML Help\Output Options]
ClassHierarchyLayoutOutputDir=output
@ -147,15 +165,16 @@ ID={D3A588E0-9472-11D3-BDD1-0080C8BA053D}
[Configurations\HTML\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\AdditionalFiles]
Count=4
File0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\html_titlebkg.jpg
File0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\footer-bkg-whitegradient.gif
File1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\header-bkg-whitegradient.gif
File2=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_fullframegradient.gif
File3=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\html_titlebkg.jpg
[Configurations\HTML\{D3A588E0-9472-11D3-BDD1-0080C8BA053D}\General]
ClearDirectoryBeforeExport=0
HelpKind=0
OutputDir=output
OutputXHTML=0
TargetBOM=0
TargetCodepage=utf-8
@ -182,6 +201,14 @@ Help2PluginNamespace=0
Help2PluginNamespaceName=MS.VSIPCC+
Help2RegisterType=0
Help2UnregisterNamespace=1
Help3BookName=
Help3Catalog=vs
Help3Locale=en-us
Help3PackageFilename=
Help3Product=MyProduct
Help3ProductVersion=100
Help3RegisterBook=1
Help3Vendor=MyCompany
HelpCompiler=
HTMLHelp2Filename=
HTMLHelpDisplayFontScaleButton=0
@ -195,8 +222,8 @@ WindowPosition_Top=0
[Configurations\HTML\Image Paths]
Count=2
Path0=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics
Path1=..\..\..\..\Program Files\Doc-O-Matic 6 Express\graphics\en
Path0=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics
Path1=..\..\..\..\..\..\..\Programme\Doc-O-Matic 7 Express\graphics\en
[Configurations\HTML\Output Options]
ClassHierarchyLayoutOutputDir=output
@ -205,14 +232,14 @@ ClassHierarchyLayoutOutputDir=output
ID={D3A588E0-9472-11D3-BDD1-0080C8BA053D}
[General]
Author=Felipe Monteiro de Carvalho
Author=Felipe Monteiro de Carvalho and Werner Pamler
AuthorEmail=
Copyright=Copyright (c) 2008
Copyright=Copyright (c) 2008-2015
Summary=Free Pascal Spreadsheet Library
Title=FPSpreadsheet
VersionBuild=0
VersionMajor=1
VersionMinor=0
VersionMinor=6
VersionRelease=0
[Macro Header Files]
@ -246,11 +273,11 @@ TrailerChars=-+~/#
WallCharacters="#$%&'*+-/=@[\]^_`{|}~
[Project File Info]
Version=604
Version=700
[Section\0]
Count=3
Description=Contains a short summary of the purpose of an object. This text usually contains one or two sentenses.
Description=Contains a short summary of the purpose of an object. This text usually contains one or two sentences.
DisplayName=Summary
EditorName=
JavaDocTags=
@ -714,6 +741,20 @@ Value2=Inputs
Value3=Input
XMLDocTags=
[Section\40]
Count=2
Description=Contains information on the license
DisplayName=License
EditorName=
JavaDocTags=license
OutputFind=
OutputReplace=
SectionFlags=15
Type=0
Value0=License
Value1=Licenses
XMLDocTags=
[Section\5]
Count=4
Description=Used to generally describe the return value of a global or member function.
@ -794,7 +835,7 @@ Value1=Seealso
XMLDocTags=
[Sections]
Count=40
Count=41
DefID=1
ID0=0
ID1=1
@ -831,6 +872,7 @@ ID37=37
ID38=38
ID39=39
ID4=4
ID40=40
ID5=5
ID6=6
ID7=7
@ -839,8 +881,12 @@ ID9=9
SavedValues=1
[Source Files]
Count=1
File0=fpspreadsheet.pas
Count=5
File0=..\..\fpsnumformat.pas
File1=..\..\fpspreadsheet.pas
File2=..\..\fpspreadsheetctrls.pas
File3=..\..\fpspreadsheetgrid.pas
File4=..\..\fpsutils.pas
[Source Include Directories]
Count=0

Binary file not shown.

View File

@ -0,0 +1,288 @@
body {
margin: 0;
color: #111111;
background-color: #FFFFFF;
font-family: "Segoe UI", "Trebuchet MS", Arial, Verdana, sans-serif;
font-size: 10pt;
text-align: left;
padding: 0.7em;
}
/* Bi-Directional support */
*[lang="he"], *[lang="ar"] /* not supported by IE */
{
direction: rtl;
text-align: right;
}
body[lang="he"], body[lang="ar"]
{
margin: 0;
color: #111111;
background-color: #FFFFFF;
font-family: "Segoe UI", "Trebuchet MS", Arial, Verdana, sans-serif;
text-align: right;
direction: rtl;
margin-right: 10.2em;
padding-right: 0.7em;
}
p {
line-height: 1.25em;
margin: 5px 0 5px 0;
}
a {
color:#4D87CE;
text-decoration:none;
}
a:hover {
color:#2a65ad;
}
ul li {
list-style-image:url(../pic/backgrounds/li.gif);
text-align:left;
margin-bottom: 2px;
margin-top: 2px;
}
#logoheader {
width:80%;
margin:0 auto 0 auto;
text-align:right;
}
#content {
margin:0 40px;
padding:0;
text-align:left;
}
/* Headers */
h1 {
font-family: "Century Gothic", "Trebuchet MS", "Arial Narrow", Arial, sans-serif;
font-size:150%;
font-weight:normal;
text-transform:uppercase;
border-bottom:1px solid #eeeeee;
margin-top: 10px;
}
#content h1 {
font-family:"Century Gothic", "Trebuchet MS", "Arial Narrow", Arial, sans-serif;
font-size:150%;
margin-bottom: 10px;
}
h2 {
font-family: "Century Gothic", "Trebuchet MS", "Arial Narrow", Arial, sans-serif;
font-size: 130%;
margin-top: 25px;
margin-bottom: 10px;
border-bottom: 1px solid #CCCCCC;
}
h3 {
font-family: "Century Gothic", "Trebuchet MS", "Arial Narrow", Arial, sans-serif;
font-size:120%;
margin-top: 15px;
margin-bottom: 5px;
}
h4, h5, h6, .subTitle {
font-family: sans-serif;
font-size: 100%;
font-weight: bold;
margin-bottom: 5px;
}
/* Code */
pre, .pascal {
background-color: #F9F9F9;
border: 1px dashed #2F6FAB;
color: black;
padding: 8px;
overflow: auto;
line-height: 125%;
}
.num {
color: #0000DD;
}
.string {
color: #800080;
}
.var {
color: #000000;
}
.key {
font-weight:bold;
}
.sym {
color: red;
}
.cmt {
color: #777777;
font-style: italic;
}
blockquote {
margin: 0 3%;
}
/* templates */
div.template-with-icon {
border-width: 1px;
border-color: #C0C0C0;
padding: 4px 8px 8px 8px;
border-style:solid;
display: block;
margin-top: 10px;
min-height: 28px;
}
div.icon {
clear: left;
float: left;
margin-right: 8px;
margin-top:0px;
}
span.keypress {
border: 0.2em outset #cecbc7;
background: #f0ece8;
padding: 0.1em 0.4em;
font-size: 80%;
white-space: nowrap;
}
div.catlinks {
background-color: #F9F9F9;
border: 1px solid #aaa;
color: #aaa;
padding: 10px;
margin-top: 20px;
}
/* images */
div.image {
border: 1px solid $C0C0C0;
padding: 3px;
margin: 8px;
font-size: 80%;
vertical-align: text-top;
}
.image-no-border {
border: 0px;
padding: 0px;
margin: 8px;
font-size: 80%;
vertical-align: text-top;
}
/* roadmap.css */
table {
margin-top: 10px;
margin-bottom: 10px;
border-collapse: collapse;
padding: 4px;
font-family: "Segoe UI", "Trebuchet MS", Arial, Verdana, sans-serif;
font-size: 10pt;
}
th {
border: 1px solid #999;
border-collapse: collapse;
padding: 4px;
background-color: #CCCCCC;
font-size: 10pt;
font-weight: bold;
text-align: center;
}
td {
border: 1px solid #999;
border-collapse: collapse;
background-color: #F7F7F7;
padding: 3px;
font-size: 10pt;
}
td.working {
background-color: #88FF88;
padding: 3px;
text-align: center;
}
td.unknown {
background-color: #FFFFFF;
padding: 3px;
text-align: center;
}
td.partial {
background-color: #FFFF88;
padding: 3px;
text-align: center;
}
td.not {
background-color: #FF8888;
padding: 3px;
text-align: center;
}
td.progress {
background-color: #8888FF;
padding: 3px;
text-align: center;
}
tr.working {
background-color: #88FF88;
padding: 3px;
text-align: center;
}
tr.unknown {
background-color: #FFFFFF;
padding: 3px;
text-align: center;
}
tr.partial {
background-color: #FFFF88;
padding: 3px;
text-align: center;
}
tr.not {
background-color: #FF8888;
padding: 3px;
text-align: center;
}
tr.progress {
background-color: #8888FF;
padding: 3px;
text-align: center;
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

@ -0,0 +1,13 @@
echo off
rem set FMT=html
set FMT=chm
echo Downloading wiki...
wikiget --page=FPSpreadsheet --page=FPSpreadsheet:_List_of_formulas --page=RPN_Formulas_in_FPSpreadsheet
wikiget --page=FPSpreadsheet_tutorial:_Writing_a_mini_spreadsheet_application
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_List_of_formulas*.xml wikixml/RPN_Formulas*.xml wikixml/FPSpreadsheet_tutorial=3A_Writing*.xml wikixml/TsWorksheet*.xml
set FMT=