__ocaml_lex_main_rec [Stog_filter_lexer] | |
__ocaml_lex_string_rec [Stog_filter_lexer] | |
__ocaml_lex_tables [Stog_filter_lexer] | |
A | |
add [Stog_trie.S] | |
add [Stog_tmap.S] | |
add [Stog_graph.S] | add g (a, b, data) adds to the graph g an edge from a to b
annotated with data .
|
add_dep [Stog_plug] |
For a given document, add a dependency on a file or another document.
|
add_dep [Stog_deps] | |
add_doc [Stog_types] | |
add_path [Stog_types] | |
append [Stog_path] | |
apply_data_env_doc [Stog_engine] | |
apply_stog_data_env_doc [Stog_engine] | |
apply_stog_env_doc [Stog_engine] | |
archive_tree [Stog_tags] | |
as_cdata [Stog_tags] | |
as_xml [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 base rules register
by plugins.
|
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_load [Stog_engine.Module] | |
cache_store [Stog_engine.Module] | |
card [Stog_tmap.S] | |
check_file_has_extension [Stog_dyn] | |
chop_extension [Stog_path] | |
close_sessions [Stog_ocaml] | |
command_line [Stog_tags] | |
compare [Stog_path] | |
compare_key [Stog_tmap.S] | |
compute [Stog_info] |
Compute internals graphs between documents.
|
concat_name [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_tmap.S] | |
create [Stog_graph.GMap] | |
create [Stog_graph.S] |
Creating an empty graph.
|
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] | |
cut_docs [Stog_cut] | |
D | |
data_of_lang [Stog_intl] | |
date_now [Stog_tags] | |
date_today [Stog_tags] | |
default_sectionning [Stog_tags] | |
default_style [Stog_tags] | |
doc [Stog_types] | |
doc [Stog_tags] | |
doc_body [Stog_tags] | |
doc_by_href [Stog_plug] | 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 [Stog_html] | 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] .
|
doc_by_path [Stog_types] | |
doc_children [Stog_types] | |
doc_date [Stog_tags] | |
doc_datetime [Stog_tags] | |
doc_dst [Stog_engine] | |
doc_dst_file [Stog_engine] |
Build the final file where the given document will be generated.
|
doc_env [Stog_engine] | |
doc_in_list [Stog_tmpl] | |
doc_intro [Stog_tags] | |
doc_keywords [Stog_tags] | |
doc_list [Stog_types] | |
doc_list [Stog_html] |
The calllback to insert a list of documents.
|
doc_navpath [Stog_tags] | |
doc_of_file [Stog_io] |
Read an document from the given absolute filename.
|
doc_path [Stog_tags] | |
doc_src [Stog_tags] | |
doc_title [Stog_tags] | |
doc_topics [Stog_tags] | |
doc_type [Stog_tags] | |
doc_url [Stog_tags] | |
doc_url [Stog_engine] |
Build the final url of the given document.
|
docs [Stog_list] | |
docs_by_path [Stog_types] | |
docs_of_args [Stog_list] | |
documents [Stog_tags] | |
dot_of_graph [Stog_info] |
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 [Stog_graph.S] | dot_of_graph ~f_node g returns the graphviz code to represent the
given graph.
|
dot_to_svg [Stog_misc] | |
dummy_ [Stog_tags] | |
dummy_pos [Stog_filter_lexer.L] | |
E | |
empty [Stog_trie.S] | |
encode_string [Stog_misc] | |
engine [Stog_filter_lexer.L] | |
english [Stog_intl] | |
env_of_defs [Stog_engine] | |
env_of_used_mods [Stog_engine] | |
error [Stog_plug] | |
error [Stog_msg] | |
error [Stog_filter_lexer] | |
error_ [Stog_tags] | |
errors [Stog_msg] | |
escape_html [Stog_html] |
Escape html code in the given string: change
& to & ,
< to < and > to > .
|
ext_a [Stog_tags] | |
external_highlight [Stog_highlight] |
Call the highlight command on the given string and make it produce xhtml code.
|
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.
|
fill_doc_from_atts_and_subs [Stog_io] | |
filter [Stog_filter_parser] | |
filter_docs [Stog_filter] | |
filter_of_string [Stog_filter] | |
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 [Stog_tmap.S] | |
find [Stog_find] | |
find_block_by_id [Stog_types] | |
find_list [Stog_find] | |
flush_input [Stog_filter_lexer.L] | |
fold [Stog_tmap.S] | |
fold [Stog_graph.GMap] | |
fold_pred [Stog_graph.S] | |
fold_succ [Stog_graph.S] | |
french [Stog_intl] | |
from_channel [Stog_filter_lexer.L] | |
from_function [Stog_filter_lexer.L] | |
from_string [Stog_filter_lexer.L] | |
fun_apply_data_doc_rules [Stog_engine] | |
fun_apply_stog_data_doc_rules [Stog_engine] | |
fun_apply_stog_doc_rules [Stog_engine] | |
fun_eval [Stog_ocaml] | |
fun_latex [Stog_latex] | |
fun_latex_body [Stog_latex] | |
fun_prefix_svg_ids [Stog_svg] | |
fun_printf [Stog_ocaml] | |
functions [Stog_tags] | |
G | |
generate [Stog_engine] |
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 [Stog_tmap.S] | |
get [Stog_graph.GMap] | |
get_def [Stog_types] | |
get_in_args_or_env [Stog_engine] | 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_engine] | |
get_languages [Stog_engine] | |
get_month [Stog_intl] | |
get_path [Stog_html] | get_path env returns the path associated to "path" in env .
|
get_path [Stog_engine] | get_path env returns the path associated to "doc-path" in env .
|
get_path_in_args_or_env [Stog_engine] |
Same as
Stog_engine.get_path but first looks for "doc-path" attribute in
the given args.
|
get_sectionning_tags [Stog_html] | |
get_template [Stog_tmpl] | |
get_template_file [Stog_tmpl] | get_template_file stog doc 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_highlight] |
Highlight the given code.
|
I | |
icode [Stog_tags] | |
id_map_add [Stog_types] | |
if_ [Stog_tags] | |
image [Stog_tags] | |
inc [Stog_tags] | |
include_ [Stog_tags] | |
incr_verbose_level [Stog_msg] | |
int [Stog_tmap.S] | |
invalid [Stog_path] | |
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_tmap.S] | |
iter [Stog_graph.GMap] | |
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] | |
late_cdata [Stog_tags] | |
late_inc [Stog_tags] | |
latex [Stog_tags] | |
latex_body [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 documents 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_files [Stog_dyn] | |
load_packages [Stog_dyn] | |
lowercase [Stog_misc] | lowercase s lowers the case of the given string, including accentuated characters.
|
M | |
main [Stog_filter_lexer] | |
make_doc [Stog_types] | |
make_module [Stog_html] | |
make_module [Stog_blocks] | |
make_path [Stog_types] | |
make_svg [Stog_latex] | |
map_doc_ref [Stog_types] | |
map_href [Stog_types] | |
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_block [Stog_blocks] | |
mk_block_node [Stog_plug] | mk_block_node ... creates a <block ... with the given information.
|
mk_levels [Stog_html] | 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 [Stog_cut] | mk_path path sep id forges a new path using the given one,
the given separator and the given id.
|
mkdir [Stog_misc] | |
modify [Stog_tmap.S] | |
modul [Stog_engine.Module] | |
module_by_name [Stog_engine] | |
module_name [Stog_html] | |
module_name [Stog_blocks] | |
modules [Stog_engine] | |
modules_dir [Stog_install] |
Default modules directory.
|
modules_dir [Stog_config] | modules_dir dir returns the modules directory, from a stog project directory.
|
N | |
n_columns [Stog_tags] | |
new_engine [Stog_filter_lexer.L] | |
new_line [Stog_filter_lexer.L] | |
next [Stog_tags] | |
next_path [Stog_tags] | |
node_of_block [Stog_blocks] | |
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] | |
ocaml_printf [Stog_tags] | |
ocamlfind [Stog_install] |
Path to ocamlfind command used for compilation.
|
of_string [Stog_path] | |
opt_in_env [Stog_engine] | |
opt_of_string [Stog_misc] | opt_of_string s returns None if the string if empty
(length is 0) or Some s .
|
P | |
page [Stog_tmpl] | |
page [Stog_tags] | |
paragraph [Stog_tags] | |
parent [Stog_path] | |
parse [Stog_of_latex] | |
path [Stog_path] | |
path_sep [Stog_tags] | |
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.
|
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 document by date.
|
pred_roots [Stog_graph.S] | pred_roots g returns the list of vertices having no predecessor in the graph.
|
prefix_svg_ids [Stog_tags] | |
prefix_svg_ids [Stog_svg] | |
prepare_toc [Stog_tags] | |
previous [Stog_tags] | |
previous_path [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_modules [Stog_io] | read_modules stog read all modules found in directories of the
list stog.stog_mod_dirs and return the modified stog structure.
|
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 doc 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_base_rule [Stog_html] | |
register_html_base_rule [Stog_plug] | register_html_base_rule name f registers a new function associated
to name in the set of base rules of the "html" predefined module.
|
register_lang [Stog_plug] | |
register_lang [Stog_intl] | |
register_module [Stog_engine] | |
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_tmap.S] | |
remove [Stog_graph.GMap] | |
remove_node [Stog_graph.S] | remove_node g a removes the vertice a from the graph g .
|
remove_not_published [Stog_info] |
Keep in the stog structure only the documents matching the
Stog_types.stog.stog_publish_only filter, if any.
|
reverse [Stog_graph.S] | reverse g return a graph where all edges of g are reversed, i.e.
|
rss [Stog_tmpl] | |
rss_item [Stog_tmpl] | |
rss_length [Stog_tags] | |
run [Stog_engine] | |
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_doc [Stog_types] | |
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] | |
share_dir [Stog_install] |
Share directory.
|
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.
|
site_desc [Stog_tags] | |
site_email [Stog_tags] | |
site_title [Stog_tags] | |
site_url [Stog_tags] | |
sort_docs_by_date [Stog_types] | |
sort_ids_docs_by_date [Stog_types] | |
sort_ids_docs_by_rules [Stog_types] | |
split_string [Stog_misc] |
Separate the given string according to the given list of characters.
|
stog_dir [Stog_tags] | |
stog_md5 [Stog_types] | |
stog_ocaml_session [Stog_ocaml] | |
string [Stog_filter_lexer] | |
string_buffer [Stog_filter_lexer] | |
string_of_date [Stog_intl] | |
string_of_date_opt [Stog_intl] | |
string_of_datetime [Stog_intl] | |
string_of_datetime_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_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_stog_directives [Stog_of_latex] | |
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] | |
subsubsection [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 document by date.
|
succ_roots [Stog_graph.S] |
Same as
Stog_graph.S.pred_roots but for vertices with no successor.
|
T | |
templates_dir [Stog_install] |
Default templates directory.
|
tmpl_dir [Stog_config] | tmpl_dir dir returns the directory containing templates, from a
stog project directory.
|
to_string [Stog_trie.S] | |
to_string [Stog_path] | |
to_xml [Stog_of_latex] | |
toc [Stog_tags] | |
today [Stog_types] | |
topic [Stog_tmpl] | |
topic [Stog_tags] | |
two_columns [Stog_tags] | |
U | |
unmarshal [Stog_graph.S] |
Unmarshal.
|
url_concat [Stog_types] | |
url_of_path [Stog_html] |
Build an url from the given path.
|
url_of_string [Stog_types] | |
V | |
verbose [Stog_plug] | |
verbose [Stog_msg] | |
verbose_level [Stog_msg] | |
version [Stog_install] |
Version of stog.
|
W | |
warning [Stog_plug] | |
warning [Stog_msg] | |
warnings [Stog_msg] | |
write_input [Stog_ocaml_types] | |
write_result [Stog_ocaml_types] | |
Y | |
yyact [Stog_filter_parser] | |
yycheck [Stog_filter_parser] | |
yydefred [Stog_filter_parser] | |
yydgoto [Stog_filter_parser] | |
yygindex [Stog_filter_parser] | |
yylen [Stog_filter_parser] | |
yylhs [Stog_filter_parser] | |
yynames_block [Stog_filter_parser] | |
yynames_const [Stog_filter_parser] | |
yyrindex [Stog_filter_parser] | |
yysindex [Stog_filter_parser] | |
yytable [Stog_filter_parser] | |
yytables [Stog_filter_parser] | |
yytablesize [Stog_filter_parser] | |
yytransl_block [Stog_filter_parser] | |
yytransl_const [Stog_filter_parser] |