Index of values

add g (a, b, data) adds to the graph g an edge from a to b annotated with data.

For a given document, add a dependency on a file or another document.

bool_of_string "0" = false and bool_of_string "false" = false.

Build the base rules, using the default ones and the base rules register by plugins.

cache_dir dir returns the cache directory, from a stog project directory.

Compute internals graphs between documents.

config_dir dir returns the stog configuration directory in the given directory.

config_file dir returns the stog config file for a given project directory, that is Filename.concat (config_dir dir) "config".

Creating an empty graph.

Creating a log function.

Same as create_log_fun but also return a function to change the log level.

doc_by_href ?typ ?src_doc stog env href returns the document, path and optional if matching the given href string, of the form path[#id].

doc_by_href ?typ ?src_doc stog env href returns the document, path and optional id matching the given href string, of the form path[#id].

Build the final file where the given document will be generated.

The calllback to insert a list of documents.

Read an document from the given absolute filename.

Build the final url of the given document.

Get graphviz code from the given stog structure, to create a graph showing edges between (clickable) documents; the edges are annotated by the topic and keywords.

dot_of_graph ~f_node g returns the graphviz code to represent the given graph.

Escape html code in the given string: change & to &, < to < and > to >.

Call the highlight command on the given string and make it produce xhtml code.

Return mdification time of the given file, or None if the file does not exist.

file_of_string ~file str creates a file named filename whose content is str.

filename_extension filename returns extension of filename or "" if there is no extension.

Find all data associated to the given path or below, or an empty list if such a path does not exist.

Generate the target files, with the following steps: create the output directory,, build the base environment from the site global attributes,, compute by-topic, by-keyword and by-month documents,, compute documents,, for each level, for each document, apply level functions on the document, output Stog_types.doc.doc_out field in the destination file.

get_in_args_or_env env args s returns the value associated to s in args of else return the result of get_in_env env s.

get_in_env env tag will look for the given string in the environment, by building a <tag/> node and evaluating it.

get_path env returns the path associated to "path" in env.

get_path env returns the path associated to "doc-path" in env.

Same as Stog_engine.get_path but first looks for "doc-path" attribute in the given args.

get_template_file stog doc file returns absolute filename of the given template filename.

Prevent tags to self-close (i.e.

Highlight the given code.

is_prefix pattern s returns true if string s begins with pattern.

isolate g a removes all edges from and to vertice a.

Same as Stog_graph.S.iter_succ but with predecessors of each vertice.

iter_succ g f calls f on each vertice and its successors as returned by Stog_graph.S.succ.

list_chop n l returns the n first documents of list l or the whole list if n >= List.length l.

list_remove_doubles ?pred l remove doubles in the given list l, according to the optional equality function pred.

lowercase s lowers the case of the given string, including accentuated characters.

Marshal the given graph.

mk_block_node ... creates a <block ... with the given information.

mk_levels modname funs default_levels returns a function to create the level map from an optional list of pairs (funname, [level1 ; level2; ...]).

mk_path path sep id forges a new path using the given one, the given separator and the given id.

Default modules directory.

modules_dir dir returns the modules directory, from a stog project directory.

nodes_by_pred_order g returns a sorted list of vertices.

Path to ocamlfind command used for compilation.

opt_of_string s returns None if the string if empty (length is 0) or Some s.

path_under ~parent file returns the path to file from parent.

plugin_config_file stog plugin_name returns the configuration file for this plugin name, for consistency purpose.

Same as Stog_graph.S.succ but returns the predecessors.

Get the previous document by date.

pred_roots g returns the list of vertices having no predecessor in the graph.

read_config file returns the configuration stored in the given stog configuration file.

read_modules stog read all modules found in directories of the list stog.stog_mod_dirs and return the modified stog structure.

Build a Stog_types.stog structure from the given directory.

read_template_file stog doc file returns the content of the given template filename, after calling Stog_tmpl.get_template_file to get the final filename.

Same as Stog_graph.S.recursive_succs but for predecessors.

recursive_succs t key returns the list of all nodes "under" the given one; the given predicate can be used to follow only some edges.

register_html_base_rule name f registers a new function associated to name in the set of base rules of the "html" predefined module.

rem g (a, b) pred removes from graph g the edges from a to b whose annotations satisfy the given predicate pred.

rem_all g (a, b) removes from graph g all edges from a to b.

remove_node g a removes the vertice a from the graph g.

Keep in the stog structure only the documents matching the Stog_types.stog.stog_publish_only filter, if any.

reverse g return a graph where all edges of g are reversed, i.e.

safe_main f calls f () but handles Sys_error and Failure exceptions by exiting with error code 1.

Use the given language abbreviation (such as "fr") to set the default language.

Share directory.

shortest_path g cost (a, b) computes the shortest path from a to b according to the cost function.

Separate the given string according to the given list of characters.

string_of_file filename returns the content of filename in the form of one string.

string_of_opt s_opt returns the empty string if s_opt = None or s if s_opt = Some s.

strip_blank_lines s works as Stog_misc.strip_string, but only strips full blank lines, without touching spaces or tabulations.

strip_string s removes all leading and trailing spaces from the given string.

succ g a returns the successors of a vertice as a list of pairs (successor, edge annotation).

Get the next document by date.

Same as Stog_graph.S.pred_roots but for vertices with no successor.

Default templates directory.

tmpl_dir dir returns the directory containing templates, from a stog project directory.

Unmarshal.

Build an url from the given path.

Version of stog.