NAME:

Package: Language


SYNOPSIS:

use lib::Language;


DIRECTORY/FILE:

The file Language.pm is located in the subdirectory './lib'


DESCRIPTION:

This package contains all function that are needed for tha style definition language and the output definition language in the 'edoc.int' and the '*.out'-files.


STATUS:

Coding: 80%

Documentation: up-do-date


FUNCTIONS:


read_stylegroup

Language::read_stylegroup($ref_hash, $stylegroup_name, $ref_styles_array)

Because all style definitions are coded in the same way in the configuration files, this function retriecves the information form the $file_array and reads the given ($stylegroup_name) and creates the corresponding branches in the anonymous configurationa hash.

Parameters:

(+) $ref_hash: A reference to the anonymous hash

(+) $stylegroup_name: The name of the stylegroup to be read (PAR_STYLES, ENV_STYLES, CHAR_STYLES, DOC_STYLES, COMMANDS, EMBOBJ)

(+) $ref_styles_array: A reference to the array that holds the STYLES block of the configuration file


process_property_value_commands

Language::process_property_value_commands($ref_hash)

This function replaces all %PROPERTY_VALUE%-commands with their values. It is called after all stylegroups have been written and all inheritances are done.

Parameters:

(+) $ref_hash: A reference to the anonymous hash


process_edoc_commands

$return_value = Language::process_edoc_commands($string);

This function processes all special commands edoc knows for his configuration files.

This are commands for 'Newline', 'Tabulator', '%INLINE_MACRO::....%' etc.

Parameters:

(+) $string: The string that contains (maybe) the commands.


process_edoc_commands_export

$return_value = Language::process_edoc_commands_export($string, $ref_docform, $tagname);

This function processes all special commands edoc knows for his configuration files and respects actual data of the current active document and it's current backend

This are commands for %IF::.....% etc.

Parameters:

(+) $string: The string that contains (maybe) the commands.

(+) $ref_docform: A reference to the calling DocForm object

(+) $tagname. The tag that gets processed for export


KNOWN BUGS:


STILL MISSING: