Image Handling
Author(s): Jose F. Morales.This module defines the handling of image commands. It defines predicates to locate and convert images in the different formats required for documentation.
Note: This part needs better documentation. -- JFMC
Usage and interface
- Library usage:
:- use_module(library(autodoc_images)). - Exports:
- Predicates:
locate_and_convert_image/4, clean_image_cache/0.
- Predicates:
- Imports:
- Application modules:
lpdocsrc(src(autodoc_state)), lpdocsrc(src(autodoc_filesystem)), lpdocsrc(src(autodoc_settings)), lpdocsrc(src(autodoc_aux)). - System library modules:
terms, make/make_rt, system_extra, system, errhandle, messages, format. - Internal (engine) modules:
term_basic, arithmetic, atomic_basic, basic_props, basiccontrol, data_facts, exceptions, io_aux, io_basic, prolog_flags, streams_basic, system_info, term_compare, term_typing, hiord_rt, debugger_support. - Packages:
prelude, nonpure, dcg, assertions, regtypes, fsyntax.
- Application modules:
Documentation on exports
PREDICATE
Usage:locate_and_convert_image(SrcSpecS,AcceptedFormats,DocSt,TargetFileS)
The image at SrcSpecS is located (as one of the known formats known_format/1) and converted to one of the AcceptedFormats. The target file is called TargetFileS
- Call and exit should be compatible with:
(string/1)SrcSpecS is a string (a list of character codes).
(list/2)AcceptedFormats is a list of atoms.
(docstate/1)docstate(DocSt)
(string/1)TargetFileS is a string (a list of character codes).
