Project Documenting Machine

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
Main
General
Project
Data
Forms
Reports
Class Libraries
Code
Labels
Other
Menus
Custom
GCT (global classes tree)

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ù.