Main window

On the page called General basic information is given and general options set for the generation of the HTML documentation. There is a page for each part of the project with specific options settings.

Obsah:

Toolbar

Clears the form for new entry.
Loads settings from a PDM file.
Saves settings to a PDM file.
Saves settings as a new PDM file.
Displays the contents of LOG file where the warnings are stored.
Displays the contents of error LOG file storing the errors which arise during processing the project files.
Seznam aplikací na zobrazení HTML dokumentace.
Displays the first page of the generated HTML documentation.
Prints the generated HTML files according to the PDMprg.log list.
Spustí dialog pro nastavení globálních voleb PDM.
Spustí dialog o aplikaci.

Main

bt. Go Runs the HTML documentation generation.
bt. Quit Closes the form.
lb. File Active PDM file.
Statusbar
(empty space)
Messages during the HTML documentation creation.
Errors
The number of fatal errors.
Warnings
The number of warnings.

General

Project The location and name of the VFP project whose documentation is to be generated.
One or more files
File list
Spustí formulář pro zadání souborů pro které se má vygenerovat HTML dokumentace.
Severally Příznak, zda se generuje HTML dokumentace pro každý soubor zvlášť.
Output directory The output directory, where the HTML documentation will be generated.
Výchozí složka Výchozí složka projektu nebo seznamu souborů. V případě projektu nemusí odpovídat složce umístění projektu. Toto nastavení ovlivňuje automatické dohledávání chybějicích souborů.
Stop if
Never
The generation will never be stopped.
No. of errors is
The generation will be stopped after the defined number of fatal errors.
(The fatal errors are errors during the files processing.)
Generate page
Project
Whether to generate the project page. (Note 1.)
Data
Whether to generate the page with a list of DBCs, free tables and queries. (Note 1.)
Forms
Whether to generate the list of formularies. (Note 1.)
Reports
Whether to generate the list reports. (Note 1.)
Classes
Whether to generate the list of VCX libraries. (Note 1.)
Code
Whether to generate the list of PRG,EXE/APP and FLL libraries. (Note 1.)
Labels
Whether to generate the list of labels. (Note 1.)
Other files
Whether to generate the list pictures and text files. (Note 1.)
Menus
Whether to generate the list of menus. (Note 1.)
Custom
Zda se má vygenerovat stránka seznamu uživatelských odkazů.
GCT
Global classes tree.
Statistics
Statistika projektu nebo seznamu souborů.
Friendly projects Runs the friendly projects dialog.
Other settings Runs the other settings dialog.
Setup Spustí formulář pro nastavení Setupu.
Cleanup Spustí formulář pro nastavení Cleanupu.
Plug-ins Spustí formulář pro nastavení plug-inů.
Comments Spustí formulář pro definování uživatelských komentářů.
Project Overview Spustí formulář pro definování zdroje přehledu projektu.
Global CSS Umístění a název globálního CSS souboru na ovlivnění vzhledu.
Global JS Umístění a název globálního JS souboru na ovlivnění funkčnosti.

Project

Sort by name
OLE public class list
Whether to sort the OLE public class list.
Key of Comments Klíč identifikující soubor komentářů v projektu.
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Data

Sort by name
DBC container list
Whether to sort the DBC container list.
Table list
Whether to sort the tables list (both tables in databases and free tables).
Query list
Whether to sort the query list.
View list
Whether to sort the view list.
Connection list
Whether to sort the connection list.
Class list
Whether to sort the list of classes.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Procedure list
Whether to sort the procedure list.
Field list
Whether to sort the list of table and view fields.
(The Or. field is the physical order of the field)
Index list
Whether to sort the index list.
(The Or. field is the physical order of the index)
Relation list
Whether to sort the relation list.
(The Or. field is the physical order of the relation)
Collapse
Main PRG
Whether to collapse the main program.
Procedures
Whether to collapse procedures.
Methods
Whether to collapse methods.
Class tree
Zda bude strom tříd (třídní hierarchie) sbalen nebo kompletně rozbalen.
Other Properties Fields
Wheter to collapse the other properties (those, that can be accessed via the DBC container).
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Generate page Zda se má generovat jedna stránka pro celý soubor událostí (Single), nebo jedna stránka na jednu třídu (Multi).
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Forms

Sort by name
File list
Whether to sort the list of files.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Collapse
Methods
Whether to collapse the methods.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Reports

Sort by name
File list
Whether to sort the list of files.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Collapse
Methods
Whether to collapse the methods.
Expressions
Whether to collapse the expressions.
Other Bands Properties or Object list
Whether to collapse other bands properties or object list.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Right Side Width Šířka pravé části detailu v procentech. Povolený rozsah je 10-100%.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Class Libraries

Sort by name
File list
Whether to sort the list of files.
Class list
Whether to sort the list of classes.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Collapse
Methods
Whether to collapse the methods..
Class tree
Zda bude strom tříd (třídní hierarchie) sbalen nebo kompletně rozbalen.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Generate page Whether to generate one page per one VCX library or one page per one class.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Code

Sort by name
File list
Whether to sort the list of files.
Class list
Whether to sort the list of classes.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Procedure list
Whether to sort the list of procedures.
Collapse
Main PRG
Whether to collapse the main program.
Procedures
Whether to collapse procedures.
Methods
Whether to collapse methods.
Class tree
Zda bude strom tříd (třídní hierarchie) sbalen nebo kompletně rozbalen.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Generate page Whether to generate all classes to one page or to generate one page per one class.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Labels

Sort by name
File list
Whether to sort the list of files.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Collapse
Methods
Whether to collapse methods.
Expressions
Whether to collapse expressions.
Other Bands Properties or Object list
Whether to collapse other bands properties or object list.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Right Side Width Šířka pravé části detailu v procentech. Povolený rozsah je 10-100%.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Other

Sort by name
File list
Whether to sort the list of files.
bt. File list Runs the file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Menus

Pokud pad či bar spouští proceduru, pak programátor tam může napsat krom těla vlastní procedury i definice dalších procedur včetně definic tříd. Proto se každý takový zdrojový kód zpracovává úplně stejně jako PRG soubor.
Sort by name
File list
Whether to sort the list of files.
Class list
Whether to sort the list of classes.
Object list
Whether to sort the list of objects.
Property list
Whether to sort the list of properties.
Method list
Whether to sort the list of methods.
Procedure list
Whether to sort the list of procedures.
Collapse
Main PRG
Whether to collapse the main program.
Procedures
Whether to collapse procedures.
Methods
Whether to collapse methods.
Class tree
Zda bude strom tříd (třídní hierarchie) sbalen nebo kompletně rozbalen.
Bar list
Zda budou seznamy barů sbaleny nebo kompletně vypsány.
Source code
Include
Zdrojové kódy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Zdrojové kódy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Zdrojové kódy označených metod a procedur budou zahrnuty do HTML dokumentace.
Description
Include
Detailní popisy metod a procedur budou zahrnuty do HTML dokumentace.
Exclude
Detailní popisy metod a procedur nebudou zahrnuty do HTML dokumentace.
Signed
Detailní popisy označených metod a procedur budou zahrnuty do HTML dokumentace.
Generate page Whether to generate all classes to one page or to generate one page per one class.
Right Side Width Šířka pravé části detailu v procentech. Povolený rozsah je 10-100%.
bt. File list Runs to file list dialog. (Note 1.)
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Custom

Sort by name
Source list
Whether to sort the list of sources.
Always copy to repository (only files) Globální volba pro zajištění zkopírování souborů do repositáře. Týká se vždy jen souborů.
bt. Source list Spustí dialog pro nastavení seznamu zdrojů. (Note. 1.)
Lokální CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Lokální JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

GCT (global classes tree)

Sort by name
Class list
Whether to sort the list of classes.
Collapse
Class tree
Zda bude strom tříd (třídní hierarchie) sbalen nebo kompletně rozbalen.
Local CSS Umístění a název lokálního CSS souboru na ovlivnění vzhledu.
Local JS Umístění a název lokálního JS souboru na ovlivnění funkčnosti.

Notes:
1)Tato volba je zakázaná, pokud je zdrojem dat seznam souborů.