Filesystem Abstraction

Author(s): Jose F. Morales.

This module provides definitions to assign unique file-system paths and names for each of the intermediate and final results of documentation generation.

Documentation on exports

REGTYPE

Usage: filename(X)

  • Description: X is the name of a file.

REGTYPE

Usage: basename(X)

  • Description: X is the base name of a file (without extension).

REGTYPE

Usage:

  • Description: The kind of intermediate/final results for a single documentation processing unit (module).

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: file_format_provided_by_backend(Ext,Backend,Subtarget)

  • Description: Backend is the backend that generates files with format Ext
  • Call and exit should be compatible with:
    (atm/1)Ext is an atom.
    (backend_id/1)Backend is a supported backend.
    (atm/1)Subtarget is an atom.

PREDICATE

Usage:

  • Description: Clean the cached information for the filesystem mapping of the documentaton generation.

PREDICATE

Usage: get_output_dir(Backend,Dir)

  • Description: Obtain the Dir directory where final documentation files will be stored

PREDICATE

Usage: get_cache_dir(Backend,Dir)

  • Description: Obtain the Dir directory where final documentation files will be stored

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: main_absfile_in_format(Ext,File)

  • Description: File is the absolute file name for the documentation in Ext format of the main module

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: absfile_for_aux(AuxName,Backend,AbsFile)

  • Description: Absolute file for an auxiliary output file (e.g. CSS, images, etc.)

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE

Usage: get_subbase(Base,Sub,SubBase)

  • Description: SubBase is the name for the sub-file (Sub) associated with Base
  • The following properties should hold upon exit:
    (basename/1)Base is the base name of a file (without extension).
    (atm/1)Sub is an atom.
    (basename/1)SubBase is the base name of a file (without extension).

PREDICATE

Usage: absfile_to_relfile(A,Backend,B)

  • Description: Obtain the relative path, w.r.t. the output directory, of an absolute file. This is useful, e.g., for URLs.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.

PREDICATE
No further documentation available for this predicate.