NAME:

Package: Backend


SYNOPSIS:

use lib::Backend;


DIRECTORY/FILE:

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


DESCRIPTION:

This package contains all function that is needed to transfer the document into the backend files.


STATUS:

Coding: 80%

Documentation: up-do-date


FUNCTIONS:


export_to_backend

@latex_file_array = Backend::export_to_backend($ref_docform);

This function transfers the document into the backend format and returns the content of the backend file in an array.

Parameters:

(+) $ref_docform: Reference of the DocForm object that holds the document to be exported


process_arguments

$return_string = Backend::process_arguments($source_string, $ref_docform, $tag_name, $style_group, $style, $ref_backend);

This function parses the given $source_string for arguments and replaces them with the arguments value.

The function returns the parsed result.

Parameters:

(+) $source_string: The string to mask.

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

(+) $tag_name: The tagname of the tag that gest exportet or the name of the window_tag that covers an embeded object

(+) $style_group: The stylegroup

(+) $style: The style name that gets exported

(+) $ref_backend: A reference to the backend-subhash


mask_for_backend

$string = Backend::mask_for_backend($source_string);

This function masks (=escapes) all special characters definded in the 'MASK'-block of the backends '*.out'-file.

Parameters:

(+) $source_string: The string to mask.

(+) $ref_backend: A reference to the $backend-hash


KNOWN BUGS:


STILL MISSING: