PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
  • Overview
  • Project documentation
  • Type of documentation
  • Documentation content
  • Documentation cover
  • Edit mode of documentation
  • Project documentation
  • Type of documentation
  • Documentation content
  • Documentation cover and preface
  • Edit mode of documentation
  • Documentation of 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 elements (windows, pages, reports, data files, items, components, assemblies, custom-folders, etc.) found in your project.
To print these documents, select:
  • "Project .. Print the project documentation". The documentation can contain all characteristics of project and elements.
  • "File .. Print the documentation". In this case, the documentation contains the characteristics of 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 characteristics of project and elements.
  • the "Print" option. In this case, the documentation contains the characteristics of 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 project.
  • GUI documentation (Graphical User Interface): Contains the representation of windows, pages and reports as well as their sequence.
  • Code documentation: Contains all processes of all objects found in the project.
  • Technical documentation: Contains the processes and the technical description of all objects found in the project.
  • Full documentation: Contains all project information. This documentation combines all other types of documentation.

Documentation content

The project documentation can contain several sections:
  • Project description (project graph, elements found in the project, project code, ...).Project description (elements found in the project, project code, ...).
  • Versions 15 and later
    Description of internal components of project.
    New in version 15
    Description of internal components of project.
    Description of internal components of project.
  • Analysis description (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 queries (logical name and physical name of queries, type of queries, analysis associated with the queries, ...),
  • the information specific to the results of queries (result items, parameters of 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: If graphic representations (project graph, UML diagrams, ...) must be printed, 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:
  • application caption,
  • title of documentation to print,
  • image of 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 an 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 project.
Project documentation

Type of documentation

Several types of documentation are proposed:
  • Overall: Contains basic information about the project elements.
  • Code: Contains all the processes of all the project objects and procedures.
  • Full documentation: Contains all project information. This type of documentation can be very large.
  • Custom: Corresponds to a selection of information to print.

Documentation content

The full documentationof the project can contain several parts:
  • Project description (elements found in the project, project code, ...).
  • Description of internal components of project.
  • Analysis description (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, ...).
  • 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, ...).
When printing the overall documentation, only the basic information about the project, windows and or pages, templates and reports is printed.
When printing a custom documentation, it is possible to choose the information to print in each part ( "Edit" button).

For the queries, you have the ability to print:
  • the graphic representation of queries,
  • the general information of queries (logical name and physical name of queries, type of queries, analysis associated with the queries, ...),
  • the information specific to the results of queries (result items, parameters of 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.
Regardless of the type of documentation chosen, it is also possible to select the different elements of the project to take into account in the documentation.
The "Modify" button allows you to select one or more windows, for example.
Only information about the selected windows will appear in the documentation.
Note: If the current project is a common project, containing WINDEV windows, Mobile windows and WEBDEV pages, it is possible to print information about all the project elements, regardless of the product used for printing.
Caution: If graphic representations (project graph, UML diagrams, ...) must be printed, the print areas must be configured beforehand. See Print areas for more details.

Documentation cover and preface

You can define a cover and a preface for the documentation.
  • The cover page can be configured via . You can define:
    • the type of cover:
    • the information displayed:
  • The preface can be written via .

Edit mode of documentation

The documentation can be printed on the selected printer. A print preview is displayed. From this preview, you can:
  • start the print,
  • export the documentation in PDF format (via the "Export" tab of the print preview).
Documentation of current element

Documentation content

The content of this documentation can be customized: only the selected information will be presented in details.
Printed documentation of a window
Printed documentation of a window
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, etc.),
  • the window image,
  • information about the controls found in the window (name and caption of controls, characteristics of controls, etc.),
  • information about the window menus (name of different options, option shortcuts, etc.),
  • the window code,
  • the code of controls found in the window,
  • the window procedures,
  • the multilingual messages of window.
  • ...
Note: If the current element is a code window, the option "File .. Print the documentation" is used to print the different codes displayed in this window.

Edit mode of documentation

The documentation can be:
  • printed,
  • exported to an 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 project.
The documentation can be printed on the selected printer. A print preview is displayed. From this preview, you can:
  • start the print,
  • export the documentation in PDF format (via the "Export" tab of the print preview).
Print area

Specifying the print areas

If graphic representations (LDM, UML diagrams, ...) must be printed, the print areas must be configured before printing the documentation.
To specify the print areas of 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 graphic representation (select "Zoom" in the "Display" pane or press Ctrl + Mouse wheel) to see 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 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 version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment