PC SOFT

WINDEVWEBDEV AND WINDEV MOBILE
ONLINE HELP

Home | Sign in | English UK
This content comes from an automatic translation.
  • Overview
  • 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
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. These folders can be printed by unrolling the Print icon under 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.
Remarks:
  • 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:
Types of folder
  • Overall: Contains basic information about the project elements.
  • Code: Contains all the processes of all the project objects and procedures.
  • Complet: Contains all project information. This type of documentation can be very large.
  • Custom: Corresponds to a selection of information to print.

Documentation content

The complet file of the project can consist of 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).
Choice of information printed in the file

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.
Project elements to print
The "Modify" button allows you to select one or more windows, for example.
Choice of elements to be printed
Only information about the selected windows will appear in the documentation.
Remark: 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.
Documentation cover and preface
  • The cover page can be configured via Configuration. You can define:
    • the type of cover:
      Type of cover
    • the information displayed:
      Cover
  • The preface can be written via Preface.

Edit mode of documentation

The documentation can be printed on the selected printer. When printing, the documentation is displayed in the report viewer. You can:
  • start the print,
  • export the documentation as PDF (via the "Export" tab).
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 can 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,
  • multilingual messages of the window.
  • ...
Remark: 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 on the selected printer. When printing, the documentation is displayed in the report viewer. You can:
  • start the print,
  • export the documentation as PDF (via the "Export" tab).
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. On the "Display" pane, in the "Edit" group, check the option "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 to view the entire graph:
    • under the "Display" pane, change 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).
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment