PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview
  • Technical documentation of the project
  • Type of information to print
  • Content of the technical documentation
  • Cover and preface of the technical documentation
  • Generating the technical documentation
  • Technical documentation of the current element
  • Content of the technical documentation
  • Generating the technical 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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Overview
You can print different technical documentations describing all the elements of the project (windows, pages, reports, data files, items, components, assemblies, Custom-Folders, etc.). To print this documentation, go to the " Print " tab, "Home" group and expand the General icon:
  • the "Print project technical documentation" option opens the corresponding wizard. You can choose the type of information to be printed. The technical documentation can contain all the characteristics of the project and its elements.
  • the "Print" option. In this case, the technical documentation will contain only the details of the current element (window, report, query, Custom-Folder, project, etc.).
    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 of the technical documentation is to be changed (from A4 to A3), you can adapt the pages of the documentation to the new format. For more details, see Print area.
  • The technical documentation cannot be printed in "Reports & Queries".
  • In previous versions, the technical documentation was referred to as "programming documentation".
  • Versions 27 and later
    When printing WLanguage code from the code editor, a dialog box appears and allows you to:
    • select the printer to be used
    • choose the paper orientation.
    • resize printing areas according to the format used by the printer, if necessary.
    New in version 27
    When printing WLanguage code from the code editor, a dialog box appears and allows you to:
    • select the printer to be used
    • choose the paper orientation.
    • resize printing areas according to the format used by the printer, if necessary.
    When printing WLanguage code from the code editor, a dialog box appears and allows you to:
    • select the printer to be used
    • choose the paper orientation.
    • resize printing areas according to the format used by the printer, if necessary.
Technical documentation of the project

Type of information to print

There are different types of technical documentation:
Types of information
  • Overall: Contains basic information about the project elements.
  • Code: Contains all the processes of all the project objects and procedures.
  • Complete: Contains all project information. This type of technical documentation can be very large extensive.
  • Custom: Corresponds to a selection of information to print.

Content of the technical documentation

The complete technical documentation of the project can contain various 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 technical documentation, you can choose the information to print in each part ( "Edit" button).
Information printed in the technical documentation

For example, for queries, you can 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 the queries (selection conditions, groups, ...),
  • the SQL code corresponding to the queries.
  • the custom-notes.
  • the business rules.
Regardless of the type of technical documentation chosen, you can also select the different elements of the project to be included.
Project elements to print
The "Modify" button allows you to select one or more windows, for example.
Selecting the elements to print
Only information about the selected windows will appear in the documentation.
Remark: If the current project contains WINDEV windows, Mobile windows and WEBDEV pages, you can print information about all the project elements, regardless of the product from which the documentation is printed.
Caution: If graphic representations (project graph, UML diagrams, ...) must be printed, the print areas must be configured beforehand. For more details, see Print areas.

Cover and preface of the technical documentation

You can define a cover and a preface for the technical documentation.
Cover and preface of the technical documentation
  • The cover page can be configured via Configuration button. You can define:
    • the type of cover:
      Type of cover
    • the information displayed:
      Cover details
  • The preface can be written via Preface.

Generating the technical documentation

The technical documentation can be printed on the selected printer. The technical documentation is displayed in the report viewer. You can:
  • start the print job,
  • export the technical documentation as PDF (via the "Export" tab).
Technical documentation of the current element

Content of the technical documentation

The content of this technical documentation can be configured: only the selected information will be presented in details.
Technical documentation of a window
Technical 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 "Print" option is used to print the different codes displayed in this window.

Generating the technical documentation

The technical documentation can be printed on the selected printer. The technical documentation is displayed in the report viewer. You can:
  • start the print job,
  • export the technical documentation as PDF (via the "Export" tab).
Print area

Specifying the print areas

If graphical representations (LDM, UML diagrams, etc.) must be printed, the print areas must be set before printing the technical documentation.
To specify the print areas of current graphic representation:
  1. On the "Display" tab, in the "Edit" group, check "Print areas". A series of borders that represent the printable areas in the technical documentation will appear in the current editor.
  2. Reduce the display of the graphic representation to view the entire graph:
    • on the "Display" tab, change the zoom value.
    • press Ctrl + Mouse wheel.
  3. With the mouse:
    • move the borders to the desired 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