Index of values

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

Adding a known block id for a given hid.

Adding a known block id for a given hid.

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

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

Build the base rules, using the default ones and the Stog_html.plugin_rules.

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

Compute internals graphs between elements.

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".

Convert the time (seconds since the epoch) to a date/time record

Creating an empty graph.

Creating a log function.

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

Access to the current stog structure.

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

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

elt_by_href ?typ stog env href returns the element, hid and optional if matching the given href string, of the form hid[#id].

elt_by_href ?typ stog env href returns the element, hid and optional if matching the given href string, of the form hid[#id].

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

The calllback to insert a list of elements.

Build the final url of the given element.

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

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: apply registered stage0 functions to the read stog structure., create the output directory,, build the base environment from the site global attributes,, compute by-topic, by-keyword and by-month elements,, compute elements,, for each level, for each element, apply level functions on the element, output Stog_types.elt.elt_out field in the destination file.

Generate a RSS file from the given list of elements.

get_hid env returns the value associated to "hid" in env.

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.

FIXME: move get_in_env elsewhere, but later

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

Prevent tags to self-close (i.e.

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

Call the highlight command on the given string and make it produce xhtml 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 elements 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.

This function is called when an element is read from the cache.

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

Marshal the given graph.

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

The name of the cache, used in for the directory name where information is cached.

nodes_by_pred_order g returns a sorted list of vertices.

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

Parse a string and return a date/time record

Parse a string and return the time (seconds since the epoch

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.

The rewrite rules registered by plugins.

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

Get the previous element 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.

Build a Stog_types.stog structure from the given directory.

read_template_file stog elt 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.

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.

Remove from the stog structure the elements having Stog_types.elt.elt_published=false.

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.

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

Convert a date/time record into the time (seconds since the epoch)

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

Stage 0 functions registered by plugins.

This function provides the information to associate to an element to store it in the cache.

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 element by date.

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

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

Unmarshal.

Unregister the rule with the given name from the plugin rules.

Build an url from the given hid, using the given optional extension.

Version of stog.