Writing /giga/dw/dng/dokuwiki/data/meta/dev/020tol/0120gens2h.meta failed
dev:020tol:0120gens2h

Create Helptext from Source

Transaction GENS2H

Descriptive names ('Description') of defined fields, and frequently also comments on these fields, are stored in the sources for the database tables. The transaction GENS2H transfers these contents to the helptexts for the relevant database fields. The 'Description' is transferred as the Name (the HLP/NAM field) and the 'Comment' as Helptext (the HLP/TXT field).

The content of the fields generated in this way form the basis for any subsequent manual editing of the helptexts, which maybe required as the original texts are often technical and not always easily comprehensible for the normal user.

Enter the name of the modules, i.e. database tables, in the 'Module(s)' field for which helptexts are to be written. The field can be filled by entering a filename that contains the names of the modules required and by clicking the [Load] button.

The 'Level' distinguishes between contextual helptexts aimed at fairly experience users. This function is not currently integrated in the application. The Level should therefore always be set to '0'.

The language of the helptext also has to be selected.

In the 'Existing Entries' field, select what should happen if a helptext for the relevant database field already exists.

  • Fill empty fields (default) - fills the 'Description' and 'Helptext' fields only if the relevant field is empty.
  • Append - adds the content from the source to the existing content of the field.
  • Replace - replaces the existing content with the content copied from the source
  • Skip - makes no changes to the existing entries

If a central helptext exists, i.e., a helptext stored for a database field without reference to a specific table, then the transaction will recognize this helptext as existing, but the entry will not be changed under any circumstances.

The character set defines the font to be used.

The Loglevel indicates how the level of detail to be written to the log.

Clicking the [Generate] button starts the process of generating the helptexts. Afterwards click [View Log] to display the log.

GENS2H sets the date and the value '—' as the User ID. The version number of existing records is not incremented.

GENS2H writes a warning (not an error) in the log for all database fields with a 'Description' longer than 60 characters (i.e. longer than the space available in the 'Description' field). This allows you to subsequently check manually whether the description may have been cut short.

The transaction 'Reorganization of Helptexts (HLP)' (REOHLP) also allows you to check in advance whether helptexts for database fields are either missing or incomplete.

Transaction Panels

Generate help entries



Datafields

Datafield Description
Display log Displays the processing log for the transaction.


dev/020tol/0120gens2h.txt · Last modified: 2024/04/05 10:10 (external edit)