Stog library reference documentation : Index of values

Index of values


__ocaml_lex_main_rec [Stog_filter_lexer]
__ocaml_lex_string_rec [Stog_filter_lexer]
__ocaml_lex_tables [Stog_filter_lexer]

A
add [Stog_graph.S]
add g (a, b, data) adds to the graph g an edge from a to b annotated with data.
add [Stog_tmap.S]
add [Stog_trie.S]
add_block [Stog_plug]
Adding a known block id for a given hid.
add_block [Stog_html]
Adding a known block id for a given hid.
add_dep [Stog_plug]
For a given element, add a dependency on a file or another element.
add_dep [Stog_deps]
add_elt [Stog_types]
add_hid [Stog_types]
apply_loaders [Stog_cache]
apply_storers [Stog_cache]
archive_tree [Stog_tags]

B
block [Stog_tags]
bool_of_string [Stog_io]
bool_of_string "0" = false and bool_of_string "false" = false.
build_base_rules [Stog_html]
Build the base rules, using the default ones and the Stog_html.plugin_rules.
by_keyword [Stog_tmpl]
by_month [Stog_tmpl]
by_topic [Stog_tmpl]

C
cache_dir [Stog_config]
cache_dir dir returns the cache directory, from a stog project directory.
cache_file [Stog_cache]
card [Stog_tmap.S]
close_sessions [Stog_ocaml]
command_line [Stog_tags]
compare_key [Stog_tmap.S]
compute [Stog_info]
Compute internals graphs between elements.
compute_elt [Stog_plug]
compute_elt [Stog_html]
config_dir [Stog_config]
config_dir dir returns the stog configuration directory in the given directory.
config_file [Stog_config]
config_file dir returns the stog config file for a given project directory, that is Filename.concat (config_dir dir) "config".
count_char [Stog_misc]
counter [Stog_tags]
create [Stog_date]
Convert the time (seconds since the epoch) to a date/time record
create [Stog_graph.GMap]
create [Stog_graph.S]
Creating an empty graph.
create [Stog_tmap.S]
create_log_fun [Stog_misc]
Creating a log function.
create_log_fun_with_set [Stog_misc]
Same as create_log_fun but also return a function to change the log level.
create_stog [Stog_types]
current_stog [Stog_html]
Access to the current stog structure.

D
data_of_lang [Stog_intl]
deps [Stog_deps]
dot_of_graph [Stog_info]
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 [Stog_graph.S]
dot_of_graph ~f_node g returns the graphviz code to represent the given graph.
dot_to_svg [Stog_misc]
dummy_pos [Stog_filter_lexer.L]

E
elements [Stog_tags]
elt [Stog_tags]
elt [Stog_types]
elt_body [Stog_tags]
elt_by_href [Stog_plug]
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 [Stog_html]
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_human_id [Stog_types]
elt_date [Stog_tags]
elt_dst_file [Stog_html]
Build the final file where the given element will be generated.
elt_hid [Stog_tags]
elt_in_list [Stog_tmpl]
elt_intro [Stog_tags]
elt_keywords [Stog_tags]
elt_list [Stog_html]
The calllback to insert a list of elements.
elt_list [Stog_types]
elt_path [Stog_tags]
elt_src [Stog_tags]
elt_title [Stog_tags]
elt_to_rss_item [Stog_html]
elt_topics [Stog_tags]
elt_type [Stog_tags]
elt_url [Stog_html]
Build the final url of the given element.
elt_url [Stog_tags]
elts_by_human_id [Stog_types]
empty [Stog_trie.S]
encode_string [Stog_misc]
engine [Stog_filter_lexer.L]
english [Stog_intl]
error [Stog_plug]
error [Stog_filter_lexer]
error [Stog_msg]
errors [Stog_msg]
escape_html [Stog_html]
Escape html code in the given string: change & to &amp;, < to &lt; and > to &gt;.
ext_a [Stog_tags]

F
file_mtime [Stog_misc]
Return mdification time of the given file, or None if the file does not exist.
file_of_string [Stog_misc]
file_of_string ~file str creates a file named filename whose content is str.
filename_extension [Stog_misc]
filename_extension filename returns extension of filename or "" if there is no extension.
filter [Stog_filter_parser]
filter_elts [Stog_filter]
filter_of_string [Stog_filter]
find [Stog_find]
find [Stog_tmap.S]
find [Stog_trie.S]
Find all data associated to the given path or below, or an empty list if such a path does not exist.
find_block_by_id [Stog_types]
find_list [Stog_find]
flush_input [Stog_filter_lexer.L]
fold [Stog_graph.GMap]
fold [Stog_tmap.S]
fold_pred [Stog_graph.S]
fold_succ [Stog_graph.S]
format [Stog_date]
format_to [Stog_date]
french [Stog_intl]
from_channel [Stog_filter_lexer.L]
from_function [Stog_filter_lexer.L]
from_string [Stog_filter_lexer.L]
fun_eval [Stog_ocaml]
fun_latex [Stog_latex]
functions [Stog_tags]

G
generate [Stog_html]
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_rss_feed_file [Stog_html]
Generate a RSS file from the given list of elements.
get [Stog_graph.GMap]
get [Stog_tmap.S]
get_cached_elements [Stog_cache]
get_def [Stog_types]
get_hid [Stog_html]
get_hid env returns the value associated to "hid" in env.
get_in_args_or_env [Stog_html]
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 [Stog_html]
get_in_env env tag will look for the given string in the environment, by building a <tag/> node and evaluating it.
get_in_env [Stog_latex]
FIXME: move get_in_env elsewhere, but later
get_month [Stog_intl]
get_template [Stog_tmpl]
get_template_file [Stog_tmpl]
get_template_file stog elt file returns absolute filename of the given template filename.
graph [Stog_tags]

H
hack_cmxs [Stog_dyn]
hack_self_closed [Stog_html5]
Prevent tags to self-close (i.e.
hcode [Stog_tags]
highlight [Stog_html]
Call the highlight command on the given string and make it produce xhtml code.
highlight [Stog_misc]
Call the highlight command on the given string and make it produce xhtml code.
human_id_of_string [Stog_types]

I
icode [Stog_tags]
if_ [Stog_tags]
image [Stog_tags]
inc [Stog_tags]
include_ [Stog_tags]
incr_verbose_level [Stog_msg]
int [Stog_tmap.S]
is_prefix [Stog_misc]
is_prefix pattern s returns true if string s begins with pattern.
isolate [Stog_graph.S]
isolate g a removes all edges from and to vertice a.
iter [Stog_graph.GMap]
iter [Stog_tmap.S]
iter_pred [Stog_graph.S]
Same as Stog_graph.S.iter_succ but with predecessors of each vertice.
iter_succ [Stog_graph.S]
iter_succ g f calls f on each vertice and its successors as returned by Stog_graph.S.succ.

K
keyword [Stog_tmpl]
keyword [Stog_tags]

L
langswitch [Stog_tags]
languages [Stog_tags]
latex [Stog_tags]
lexeme [Stog_filter_lexer.L]
lexeme_char [Stog_filter_lexer.L]
lexeme_end [Stog_filter_lexer.L]
lexeme_end_p [Stog_filter_lexer.L]
lexeme_start [Stog_filter_lexer.L]
lexeme_start_p [Stog_filter_lexer.L]
list [Stog_tags]
list_chop [Stog_misc]
list_chop n l returns the n first elements of list l or the whole list if n >= List.length l.
list_compare [Stog_misc]
list_concat [Stog_misc]
list_remove_doubles [Stog_misc]
list_remove_doubles ?pred l remove doubles in the given list l, according to the optional equality function pred.
load [Stog_cache.Cache]
This function is called when an element is read from the cache.
load_files [Stog_dyn]
load_packages [Stog_dyn]
localzone [Stog_date]
lowercase [Stog_misc]
lowercase s lowers the case of the given string, including accentuated characters.

M
main [Stog_filter_lexer]
make_elt [Stog_types]
make_human_id [Stog_types]
make_svg [Stog_latex]
map_opt [Stog_misc]
marshal [Stog_graph.S]
Marshal the given graph.
max_deps_date [Stog_deps]
md5 [Stog_misc]
merge_stogs [Stog_types]
mk_mail_date [Stog_date]
mk_usenet_date [Stog_date]
mkdir [Stog_misc]
modify [Stog_tmap.S]
modules_dir [Stog_config]
modules_dir dir returns the modules directory, from a stog project directory.

N
n_columns [Stog_tags]
name [Stog_cache.Cache]
The name of the cache, used in for the directory name where information is cached.
new_engine [Stog_filter_lexer.L]
new_line [Stog_filter_lexer.L]
next [Stog_tags]
nodes_by_pred_order [Stog_graph.S]
nodes_by_pred_order g returns a sorted list of vertices.

O
ocaml [Stog_tags]
ocaml_eval [Stog_tags]
opt_of_string [Stog_misc]
opt_of_string s returns None if the string if empty (length is 0) or Some s.
output_cache_info [Stog_cache]

P
page [Stog_tmpl]
page [Stog_tags]
parse [Stog_date]
Parse a string and return a date/time record
parse_epoch [Stog_date]
Parse a string and return the time (seconds since the epoch
path_under [Stog_misc]
path_under ~parent file returns the path to file from parent.
plugin_config_file [Stog_plug]
plugin_config_file stog plugin_name returns the configuration file for this plugin name, for consistency purpose.
plugin_rules [Stog_html]
The rewrite rules registered by plugins.
post [Stog_tags]
pred [Stog_graph.S]
Same as Stog_graph.S.succ but returns the predecessors.
pred_by_date [Stog_info]
Get the previous element by date.
pred_roots [Stog_graph.S]
pred_roots g returns the list of vertices having no predecessor in the graph.
prepare_toc [Stog_tags]
previous [Stog_tags]

R
read_config [Stog_config]
read_config file returns the configuration stored in the given stog configuration file.
read_input [Stog_ocaml_types]
read_result [Stog_ocaml_types]
read_stog [Stog_io]
Build a Stog_types.stog structure from the given directory.
read_template_file [Stog_tmpl]
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.
recursive_preds [Stog_graph.S]
Same as Stog_graph.S.recursive_succs but for predecessors.
recursive_succs [Stog_graph.S]
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_cache [Stog_plug]
register_cache [Stog_cache]
register_lang [Stog_plug]
register_lang [Stog_intl]
register_level_fun [Stog_plug]
register_level_fun [Stog_html]
register_level_fun_on_elt_list [Stog_plug]
register_level_fun_on_elt_list [Stog_html]
register_rule [Stog_plug]
register_stage0_fun [Stog_plug]
rem [Stog_graph.S]
rem g (a, b) pred removes from graph g the edges from a to b whose annotations satisfy the given predicate pred.
rem_all [Stog_graph.S]
rem_all g (a, b) removes from graph g all edges from a to b.
remove [Stog_graph.GMap]
remove [Stog_tmap.S]
remove_node [Stog_graph.S]
remove_node g a removes the vertice a from the graph g.
remove_not_published [Stog_info]
Remove from the stog structure the elements having Stog_types.elt.elt_published=false.
reverse [Stog_graph.S]
reverse g return a graph where all edges of g are reversed, i.e.
rss_date_of_date [Stog_html]
rss_length [Stog_tags]

S
safe_main [Stog_misc]
safe_main f calls f () but handles Sys_error and Failure exceptions by exiting with error code 1.
safe_mkdir [Stog_misc]
search_form [Stog_tags]
section [Stog_tags]
sep [Stog_tags]
set [Stog_graph.GMap]
set_default_lang [Stog_intl]
Use the given language abbreviation (such as "fr") to set the default language.
set_elt [Stog_types]
set_elt_env [Stog_cache]
set_print_error [Stog_plug]
set_print_error [Stog_msg]
set_print_verbose [Stog_plug]
set_print_verbose [Stog_msg]
set_print_warning [Stog_plug]
set_print_warning [Stog_msg]
set_verbose_level [Stog_msg]
short_string_of_date [Stog_intl]
shortest_path [Stog_graph.S]
shortest_path g cost (a, b) computes the shortest path from a to b according to the cost function.
since_epoch [Stog_date]
Convert a date/time record into the time (seconds since the epoch)
site_desc [Stog_tags]
site_email [Stog_tags]
site_title [Stog_tags]
site_url [Stog_tags]
sort_elts_by_date [Stog_types]
sort_ids_elts_by_date [Stog_types]
sort_ids_elts_by_rules [Stog_types]
split_string [Stog_misc]
Separate the given string according to the given list of characters.
stage0_funs [Stog_html]
Stage 0 functions registered by plugins.
stog [Stog_plug]
stog_cache_name [Stog_cache]
stog_md5 [Stog_types]
stog_ocaml_session [Stog_ocaml]
store [Stog_cache.Cache]
This function provides the information to associate to an element to store it in the cache.
string [Stog_filter_lexer]
string_buffer [Stog_filter_lexer]
string_of_date [Stog_intl]
string_of_date_opt [Stog_intl]
string_of_file [Stog_misc]
string_of_file filename returns the content of filename in the form of one string.
string_of_human_id [Stog_types]
string_of_opt [Stog_misc]
string_of_opt s_opt returns the empty string if s_opt = None or s if s_opt = Some s.
string_of_time [Stog_misc]
string_of_url [Stog_types]
strip_blank_lines [Stog_misc]
strip_blank_lines s works as Stog_misc.strip_string, but only strips full blank lines, without touching spaces or tabulations.
strip_string [Stog_misc]
strip_string s removes all leading and trailing spaces from the given string.
sub_lexeme [Stog_filter_lexer.L]
sub_lexeme_char [Stog_filter_lexer.L]
sub_lexeme_char_opt [Stog_filter_lexer.L]
sub_lexeme_opt [Stog_filter_lexer.L]
subsection [Stog_tags]
succ [Stog_graph.S]
succ g a returns the successors of a vertice as a list of pairs (successor, edge annotation).
succ_by_date [Stog_info]
Get the next element by date.
succ_roots [Stog_graph.S]
Same as Stog_graph.S.pred_roots but for vertices with no successor.

T
tm_of_date [Stog_intl]
tmpl_dir [Stog_config]
tmpl_dir dir returns the directory containing templates, from a stog project directory.
toc [Stog_tags]
today [Stog_types]
topic [Stog_tmpl]
topic [Stog_tags]
two_columns [Stog_tags]

U
unmarshal [Stog_graph.S]
Unmarshal.
unregister_rule [Stog_plug]
Unregister the rule with the given name from the plugin rules.
url_concat [Stog_types]
url_of_hid [Stog_html]
Build an url from the given hid, using the given optional extension.
url_of_string [Stog_types]

V
verbose [Stog_plug]
verbose [Stog_msg]
verbose_level [Stog_msg]
version [Stog_config]
Version of stog.

W
warning [Stog_plug]
warning [Stog_msg]
warnings [Stog_msg]
write_input [Stog_ocaml_types]
write_result [Stog_ocaml_types]