NAME:

Package: Parts


SYNOPSIS:

use lib::Parts;


DIRECTORY/FILE:

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


DESCRIPTION:

This package contains all function that are needed for handeling the 'parts'.


STATUS:

Coding: 50%

Documentation: up-do-date


FUNCTIONS:


load_global_parts()

my $ok = Parts::load_global_parts();

Reads the global parts from the file 'edoc.pts'.

-> This function might move into the package 'InOut.pm' because it reads from the disk !


save_global_parts()

my $ok = Parts::save_global_parts();

Saves the global parts to the file 'edoc.pts'.

-> This function might move into the package 'InOut.pm' because it writes to the disk !


read_parts_array()

Parts::read_parts_array($ref_array, $ref_parts_hash_root);

Reads the array-block called 'PARTS' in the referenced array and builds ub the hash of arrays in the $ref_parts_hash_root.

Parameters:

(+) $ref_array: A reference to an array in the e:doc filesys that has a 'PARTS' block.

(+) $ref_parts_hash_root : A reference to a hash that will hold all parts there (as a hash of arrays)


build_parts_array()

my @array = Parts::build_parts_array($ref_parts_hash_root);

Builds up an array including all parts in an array.

This array will be usually saved as an array-block called 'PARTS'.

Parameters:

(+) $ref_parts_hash_root : A reference to a hash that holds all parts there (as a hash of arrays)


KNOWN BUGS:


STILL MISSING: