PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

  • Overview
  • Project documentation
  • Type of documentation
  • Documentation content
  • Documentation cover
  • Edit mode of documentation
  • Documentation of the current element
  • Documentation content
  • Edit mode of documentation
  • Print area
  • Specifying the print areas
  • Modifying the print format
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
You have the ability to print the documents presenting all the elements (windows, pages, reports, data files, items, components, assemblies, custom-folders, ...) found in your project.
To print these documents, select:
  • "Project .. Print the project documentation". The documentation can contain all the characteristics of the project and elements.
  • "File .. Print the documentation". In this case, the documentation contains the characteristics of the current element (window, report, query, custom-folder, project, ...).
These documentations can be printed by expanding the icon found on the "Home" pane in the "General" group:
  • the option "Print the project documentation" is used to start the wizard for printing the documentation. You have the ability to choose the type of documentation to print for the project. The documentation can contain all the characteristics of the project and elements.
  • the "Print" option. In this case, the documentation contains the characteristics of the current element (window, report, query, custom-folder, project, ...).
    If the "Print" option is used on a simple element (the code of an element for example), only this element will be printed.
Notes:
  • If the print format must be modified (from A4 to A3), the documentation pages can be adapted to the new format. See Print area for more details.
  • The documentation cannot be printed in "Reports and Queries".
Project documentation

Type of documentation

Several types of documentation are proposed:
  • Analysis/Data Files/Queries documentation: Contains information about the analysis, files and queries of the project.
  • GUI documentation (Graphical User Interface): Contains the representation of windows, pages and reports as well as their sequence.
  • Code documentation: Contains all the processes of all the objects found in the project.
  • Technical documentation: Contains the processes and the technical description of all the objects found in the project.
  • Full documentation: Contains all the project information. This documentation combines all the other types of documentation.

Documentation content

The project documentation can contain several sections:
  • Description of the project (project graph, elements found in the project, project code, ...).
  • Versions 15 and later
    Description of internal components of the project.
    New in version 15
    Description of internal components of the project.
    Description of internal components of the project.
  • Description of the analysis (analysis graph, data dictionary, ...).
  • Description of windows and/or pages (image of windows, list of controls found in each window, ...).
  • Description of window templates or page templates
  • Description of reports (image of reports, list of controls found in each report, ...).
  • Versions 15 and later
    Description of report templates.
    New in version 15
    Description of report templates.
    Description of report templates.
  • Description of queries (image of queries, corresponding SQL code, ...).
  • Description of classes (code of classes, ...).
  • Description of UML models (UML diagrams, list of diagram relationships, ...).
  • Description of flexible modeling (diagram, list of applications, list of components, ...).
  • Description of sets of procedures (code, multilingual messages, custom-notes, ...).
  • Description of automatic tests (code, summary of results).
  • Description of business rules (description, attached files, links, ...).
For each section, you have the ability to choose the information that will be printed.
For the queries, you have the ability to print:
  • the graphic representation of queries,
  • the general information of the queries (logical name and physical name of the queries, type of queries, analysis associated with the queries, ...),
  • the information specific to the results of the queries (result items, parameters of the queries, sort criteria, ...),
  • the information about the characteristics of queries (selection conditions, groups, ...),
  • the SQL code corresponding to the queries.
  • the custom-notes.
  • the business rules.
For each section, you have the ability to choose the elements that will be presented in details.
For example, the project windows are listed. You have the ability to select one or more windows from this list. Only the information regarding the selected windows will be displayed in the documentation.
Note: If the current project is a common project, containing WINDEV windows, Mobile windows and WEBDEV pages, you will have the ability to print information about all the project elements, regardless of the product used for printing.
Caution: To print graphic representations (project graph, UML diagrams, ...), the print areas must be configured beforehand. See "Print areas" for more details.

Documentation cover

The project documentation can include a cover page used to present the project. This cover page can contain the following elements:
  • caption of the application,
  • title of the documentation to print,
  • image of the cover,
  • information about the company.
The information printed on the cover is directly entered in the wizard for creating the project documentation.

Edit mode of documentation

The documentation can be:
  • printed on a printer,
  • exported to a RTF document, to an XML file,
  • exported to an HTML file (an Internet browser must be installed on the current computer),
  • exported to a text file.
Note: The documentation files are created in the "Documentation" directory of the project.
Documentation of the current element

Documentation content

The content of this documentation can be customized: only the selected information will be presented in details.
For example, if the current element is a window, you have the ability to print one or more of the following details:
  • general information about the window (logical and physical names, title, ...),
  • the image of the window,
  • information about the controls found in the window (name and caption of the controls, characteristics of the controls, ...),
  • information about the window menus (name of the options, option shortcuts, ...),
  • the code of the window,
  • the code of the controls found in the window,
  • the procedures of the window,
  • the multilingual messages of the window.
  • ...
Note: If the current element is a code window, the option "File .. Print the documentation" is used to print the processes displayed in this window.

Edit mode of documentation

The documentation can be:
  • printed,
  • exported to a RTF document, to an XML file,
  • exported to an HTML file (an Internet browser must be installed on the current computer),
  • exported to a text file.
Note: The documentation files are created in the "Documentation" directory of the project.
Print area

Specifying the print areas

To print graphic representations (project graph, LDM, UML diagrams, ...), the print areas must be configured before printing the documentation.
To specify the print areas of the current graphic representation:
  1. Select "Display .. Print areas". Borders representing the areas that can be printed in the documentation are displayed in the current editor.On the "Display" pane, in the "Edit" group, check "Print areas". Borders representing the areas that can be printed in the documentation are displayed in the current editor.
  2. Reduce the display of the graphic representation ("Display .. Zoom" or [Ctrl] + Mouse wheel) to view the entire graph.Reduce the display of the graphic representation to view the entire graph:
    • on the "Display" pane, modify the zoom value.
    • press [Ctrl] + Mouse wheel.
  3. With the mouse:
    • moves the borders to the requested location by keeping the mouse button down (the mouse cursor is black).
    • choose the number of pages on which the graphic representation must be printed (the mouse cursor turns into a North-West/South-East double arrow).

Modifying the print format

If the print format is modified (from A4 to A3 for example in the properties of the printer), the documentation pages can be adapted to the new format. To do so:
  1. Define the print areas.
  2. Display the layout options of the documentation ("File .. Documentation layout").Display the layout options of the documentation: on the "Home" pane, in the "General" group, expand and select "Documentation layout".
  3. Select "Resize the print areas of the opened documents".
  4. Print the documentation.
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment