Commit b80f50c3 authored by FAGES Francois's avatar FAGES Francois

devcom

parent 4d5cd4fa
......@@ -3,6 +3,7 @@
[
doc/1,
devdoc/1,
devcom/1,
grammar/1,
biocham/1,
biocham_silent/1,
......@@ -24,6 +25,10 @@ doc(_) :-
devdoc(_) :-
doc('Writes in the Developer Manual.').
devcom(_) :-
doc('Writes a comment in the Developer Manual.').
grammar(_) :-
doc('Declares a grammar predicate to be written in the documentation.').
......@@ -66,6 +71,8 @@ format_doc_html(document_opening(Title)) :-
h5 {font-family: "Courier New"; font-size: 1.1em; font-weight: normal; }
div.indented {margin-left: 1cm; }
div.example {margin-left: 1cm; }
blockquote.gray {color : gray; }
blockquote.red {color : red; }
</style>
<body>
<h1>~a</h1>
......@@ -188,6 +195,14 @@ format_doc_html(end(emph)) :-
!,
format('</em>', []).
format_doc_html(begin(quote)) :-
!,
format('<blockquote class="red"><em><strong>Comment. </strong>', []).
format_doc_html(end(quote)) :-
!,
format('</em></blockquote>', []).
format_doc_html(begin(texttt)) :-
!,
format('<code>', []).
......@@ -469,6 +484,14 @@ format_doc_tex(end(emph)) :-
!,
format('}', []).
format_doc_tex(begin(quote)) :-
!,
format('\\color{red}\\begin{quote}\\emph{\\bold{Comment. }', []).
format_doc_tex(end(quote)) :-
!,
format('}\\end{quote}\\color{black}', []).
format_doc_tex(begin(texttt)) :-
!,
format('\\texttt{', []).
......@@ -1013,6 +1036,11 @@ generate_clause(Clause, Variables, VariableNames, Type) :-
;
Clause = (:- devdoc(Contents)),
Type = devdoc
;
Clause = (:- devcom(Comment)),
atom_concat('\\begin{quote}',Comment,BC),
atom_concat(BC,'\\end{quote}',Contents),
Type = devdoc
)
->
write_doc(Contents)
......@@ -1568,6 +1596,10 @@ write_command(begin, example) :-
!,
format_doc(begin(example)).
write_command(begin, quote) :-
!,
format_doc(begin(quote)).
write_command(item, Argument) :-
!,
close_opened_li,
......@@ -1589,6 +1621,10 @@ write_command(end, example) :-
!,
format_doc(end(example)).
write_command(end, quote) :-
!,
format_doc(end(quote)).
write_command(section, Argument) :-
!,
nb_getval(current_counters, Counters),
......
......@@ -14,11 +14,15 @@
:- doc('
Biocham v4 uses the GNU Scientific Library (GSL \\url{http://www.gnu.org/software/gsl/}) to perform numerical simulations.
The page
\\url{http://www.gnu.org/software/gsl/manual/html_node/Stepping-Functions.html#Stepping-Functions}
gives a detailed description of all the numerical methods listed below.
gives a detailed description of all the numerical methods and options listed below.
').
:- devcom('FF: The correspondance with GSL methods, options and stochastic simulation are unclear. At least a description of the options is necessary.
The default values should be documented also.').
:- grammar(method).
......
......@@ -76,7 +76,7 @@
- formal_derivation.pl
- gsl.pl
- numerical_simulation.pl
** Traces and tables
** Numerical data time series, simulation traces and tables
- tables.pl
** Plotting the result of simulations
- plot.pl
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment