Mktdir

Names in this program are based on English with International Latin spelling, e.g. 'kopi' for 'copy' and 'meikfayl' for 'makefile', as (to be) explained in

with with occasional Esperanto (such as replacing words such as 'write'/'rait', that become unwieldy in interlatin spelling, with 'skrib')

General Basic Routines

Function copyfile

Function tcek_mailadr_varz

Function grpdir_p

Find out whether the current directory is a group node, i.e. directory-wise-parallel to its menu-wise parent.

If the directory contains a '@grpdoks' file or is indicated by the --grpdir option this is true.

Function gdp_set_pwd

If the current node is a group node (pwd_get_grpdir_p) and we are not using a dot argument, go to the parent directory.

Function fol2dir

Turn a directory value as specified on the commandline into an absolute directory

Function set_dir_varz

DOTDIR: If the leaf is '.', i.e. the current directory, we do not need subadd later, and the template that our created/extended document uses is no longer the one specified by konfig.subtmpl but konfig.tmpl

This should come before 'subadd', which depends on the supdir-related behaviour and uses the dotdir info.

It should come before 'set_dok_varz'; it should not write anything to the database.

Do not confuse with the supdir and supdok functions of A2E::Dokfs; here we take a different path; we create the data that the supdir/supdok functions can later use.

The variable $m->{grpdir_fol} is reset in gdp_set_pwd only if needed. The boolean flag $m->{grpdir_p} is always set to tell us whether we are working from a group node. If so the grpdir_fol must have been set.

Global variable @tratoks

Function lang_set_tmplvars

Read variables from the vocabulary files of the document type and write them into the template variables hash; omit those that belong to a group of forbidden variables (non_tmplvars). Choose the default language if none was given. Preconditions: suplangs (languages of superior document node) must be known. A second argument indicates whether language-neutral files should be read as well; this is done only the first time.

set_dok_varz

Find out what kind of a location our leaf is (whether we can write there, whether it is a tree trunk), store some basic configuration values into memory, write others to the database.

The database must be edited only if we are creating a new document, i.e. not SAMDOK.

Add the leaf to the branch.

For this to work we must be in the directory from where the leaf is added to the menu.

This may be different from the directory to which the subdirectory is added, aka supdir: some directories are heads of groups (grpdir, containing a @grpdoks file).

DOTDIR: if we are working in the current directory (see DOTDIR), we omit this step, because we assume that we are just adding a new language to an existing document. Don't mind if the document is a top-level document and thus not subordinate to the current document in a strict sense. If $m->{konfig}->force (commandline option --force) is set, go ahead even in the

Set further variables

Once we have identified the directory, document and position in the hierarchy, we are ready to set some more variables and perform some checks.

Function dir_set_url

This does not read anything from an existing directory, can therefore come relatively early.

Since the sequence of checking directories against urls is critical, we can not use a hash variable for our dirurls config option!

Function num2alpha35

Function datum_set_tmplvars

Install the target directory with some basic files

Function seif_mkdir

Safely create a directory after moving blocking data out of the way. Refrain from creating if the data indicates that the document node shouldn't be here. Make sure we are svn-wise up to date. Retrieve-store info about languages of any pre-existing dok (oldlangs). This comes before pars_args.

Function transkopi

Copy a template from its source to its destination and transform it, using the Template toolkit.

Function set_oldlangs

Find out for which languages the present node already contains body documents and store these in @{$m->{oldlangs}}.

This is relevant only for existing documents, i.e. cases where dokdir_p is true or where we are entering into an existing directory in seif_mkdir. It must be there before we have parsed the commandline arguments i.e. pars_args.

Function pars_args

Check all arguments and store them into a hash $m->{lngtags}, from which they are later read when they are used.

Write the files

First evaluate all the commandline parameters, start writing only if they are OK.

Function topdok_kopi

Arg1 is the filename suffix. The rest of the filename is determined by other factors: the tmplsupdir and topsty config variables.

If template variables are present in arg 2 then use transkopi for the transformations, using the Template toolkit with the star style.

Try with more or less specific directory and base names. Die if no suitable default file is found.

Function topdok_install

Function riid_frazfayl

If a text building block file already exists, store any variable assignements found therein in their raw original form as whole lines in a hash %vars, but identify the variable and use it as hash index. Return %vars.

This is used by skrib_antefayl0, skrib_antefayl, skrib_postfayl and skrib_postfayl0

Function tmpl_skrib_fayl

Function invalid_msg

Function mktdir_input_lit

Read a lingual text from the command line. Return input value and whether it is old, i.e. the input just confirmed what was already in the template.

Function konf_skrib_postfayl

Write a postfayl '@lng.*.??.txt' from scratch based on configuration variables and preset variables.

Function skrib_postfayl

Write language dependent tags from object variable lngtags into a lng_fayl and add that to the repository. If a file exists, reuse variables found therein. If a template exists, use that, otherwise write from memory based on configuration and preexisting variables.

Function skrib_antefayl0

Function skrib_antefayl

Function skrib_postfayl0

Function tmplsrcfayl

Return full pathname for basename arg1, obtained by searching through the template directories. The returned pathname has been found to exist. arg2ff is a list of options containing the boolean option insist which switches off search in parent directories. If the insist option is true and nothing is found, die.

Function doknavtmplfayl

find the appropriate template file, as specified by a naming config option from A2E::Dokfs(3), by seeking it in a series of directories specified in A2E::Tmplkonf(3), from the lowest (most specific) to the highest (most generic) possible template.

Function mldok_pre_set_tmplvars

Function skrib_mldok

Function skrib_mlnav

Function mlht_skrib_faylz

Set up the text elements (read vocabulary dbm files), write out the main document bodies, first language-dependent parts with different dbm files as basis, then language-independent parts with original of topdok as basis.

Function skrib_langs_fayl

skrib_meikfayl

Function konf_skrib_konf

Write out information from configuration variables to configuration file (e.g. '@dokfs').

Function skrib_konf

Write out a @dokfs file, either based on a template that could be found in the topdok directory, or based on configuration variable settings. EKZISTS: Do so only if no such file ekzists yet, i.e. dont do so if we are only adding another language version to a document.

Finishup and postprocessing

Add accumulated files and some further ones to Subversion repository. Write metadata to the database. Set up a link to an mbox if found.

Function svn_add_faylz

Enlist some remaining files that were not (as would be preferrable) enlisted upon creation. Then add all candidates to the svn repository.

Function mktdir_finic

The bulk of the mktdir5/mktdir4/mktdir0 program, starting right after parsing of commandline options.