☰

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

REGTYPEfilename/1

Usage:filename(X)

X is the name of a file.

    REGTYPEfilename_noext/1

    Usage:filename_noext(X)

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

      PREDICATEcleanup_vpath/0
      No further documentation available for this predicate.

      PREDICATEadd_vpath/1
      No further documentation available for this predicate.

      PREDICATEvpath_indir/1
      No further documentation available for this predicate.

      PREDICATEfind_file/2
      No further documentation available for this predicate.

      PREDICATEfind_file/3
      No further documentation available for this predicate. Meta-predicate with arguments: find_file(?,pred(1),?).

      PREDICATEfind_doc_source/2
      No further documentation available for this predicate.

      REGTYPEsubtarget/1

      Usage:

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

        PREDICATEfile_format_name/2
        No further documentation available for this predicate.

        REGTYPEsupported_file_format/1

        Usage:supported_file_format(F)

        F is a supported LPdoc target doc format.

          PREDICATEformat_get_subtarget/3

          Usage:format_get_subtarget(Format,Backend,Subtarget)

          Backend and Subtarget are the backend and subtarget that generates files with format Format

          • Call and exit should be compatible with:
            (atm/1)Format is an atom.
            (backend_id/1)Backend is a supported backend.
            (atm/1)Subtarget is an atom.

          PREDICATEformat_get_file/3

          Usage:format_get_file(Format,Mod,File)

          File is the principal file for Mod in format Format

          • Call and exit should be compatible with:
            (atm/1)Format is an atom.
            (atm/1)Mod is an atom.
            (atm/1)File is an atom.

          PREDICATEclean_fs_db/0

          Usage:

          Clean the cached information for the filesystem mapping of the documentaton generation.

            PREDICATEget_output_dir/2

            Usage:get_output_dir(Backend,Dir)

            Dir is the directory where the documentation files are generated. Note that this is not the installation directory.

              PREDICATEget_cache_dir/2

              Usage:get_cache_dir(Backend,Dir)

              Dir is the directory where temporary documentation files will be stored (for the active backend)

                PREDICATEget_cache_dir0/2

                Usage:get_cache_dir0(Backend,Dir)

                Dir is the directory where temporary documentation files will be stored (for all backends)

                  PREDICATEensure_output_dir/1
                  No further documentation available for this predicate.

                  PREDICATEensure_cache_dir/1
                  No further documentation available for this predicate.

                  PREDICATEabsfile_for_aux/3

                  Usage:absfile_for_aux(AuxName,Backend,AbsFile)

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

                    PREDICATEabsfile_for_subtarget/4
                    No further documentation available for this predicate.

                    PREDICATEmain_output_name/2
                    No further documentation available for this predicate.

                    PREDICATEmain_output_name_novers/1
                    No further documentation available for this predicate.

                    PREDICATEget_parent_bundle/1
                    No further documentation available for this predicate.

                    PREDICATEget_modspec/2
                    No further documentation available for this predicate.

                    PREDICATEmodname_nodoc/2
                    No further documentation available for this predicate.

                    PREDICATEmodspec_nodoc/2
                    No further documentation available for this predicate.

                    PREDICATEget_subbase/3

                    Usage:get_subbase(Base,Sub,SubBase)

                    SubBase is the name for the sub-file (Sub) associated with Base

                    • The following properties should hold upon exit:
                      (filename_noext/1)Base is the base name of a file (without extension).
                      (atm/1)Sub is an atom.
                      (filename_noext/1)SubBase is the base name of a file (without extension).

                    PREDICATEabsfile_to_relfile/3

                    Usage:absfile_to_relfile(A,Backend,B)

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

                      PREDICATEclean_all/0
                      No further documentation available for this predicate.

                      PREDICATEclean_docs_no_texi/0
                      No further documentation available for this predicate.

                      PREDICATEclean_all_temporary/0
                      No further documentation available for this predicate.

                      PREDICATEclean_intermediate/0
                      No further documentation available for this predicate.

                      PREDICATEpred_to_glob_pattern/2
                      No further documentation available for this predicate. Meta-predicate with arguments: pred_to_glob_pattern(pred(1),?).

                      Generated with LPdoc using Ciao