Permalink
Browse files

Update notes on API docs for core, tools, library, and contributions

  • Loading branch information...
pmoura committed Oct 11, 2018
1 parent 0f48acf commit e7bbfdbd1eb40e9e397b2fde3a06b5604dc8054a
Showing with 20 additions and 93 deletions.
  1. +5 −32 contributions/NOTES.md
  2. +4 −1 contributions/pddl_parser/README.txt
  3. +5 −28 core/NOTES.md
  4. +5 −31 library/NOTES.md
  5. +1 −1 tools/NOTES.md
View
@@ -61,36 +61,9 @@ a short description of each included contribution:
See the copyright and license information on the contributed files for
usage and distributions conditions.
The `contributions/loader.lgt` file loads all contributions and is
mainly used when generating the XHTML documentation by following the
steps:
The `contributions/loader.lgt` file loads all contributions.
(1) Load all contributions using the query:
| ?- {contributions(loader)}.
(2) Load the `lgtdoc` tool and generate the XML documenting files for all
library entities using the queries:
| ?- {lgtdoc(loader)}.
...
| ?- lgtdoc::library(flags, [xml_docs_directory('$LOGTALKUSER/docs/tmp1')]),
lgtdoc::library(pddl_parser, [xml_docs_directory('$LOGTALKUSER/docs/tmp2')]),
lgtdoc::library(verdi_neruda, [xml_docs_directory('$LOGTALKUSER/docs/tmp3')]),
lgtdoc::library(xml_parser, [xml_docs_directory('$LOGTALKUSER/docs/tmp4')]),
lgtdoc::library(iso8601, [xml_docs_directory('$LOGTALKUSER/docs/tmp5')]).
(3) Run the command `lgt2html` on the temporary directories to generate the
(X)HTML documentation or the command `lgt2pdf` to generate PDF documentation:
$ cd "$LOGTALKUSER/docs/tmp1" && lgt2html -i flags.html -t "Flags" && mv *.html ..
$ cd ../tmp2 && lgt2html -i pddl_parser.html -t "PDDL Parser" && mv *.html ..
$ cd ../tmp3 && lgt2html -i verdi_neruda.html -t "Verdi Neruda" && mv *.html ..
$ cd ../tmp4 && lgt2html -i xml_parser.html -t "XML Parser" && mv *.html ..
$ cd ../tmp5 && lgt2html && rm index.html && mv *.html ..
After generating the (X)HTML and/or PDF documentation, you can delete the
temporary directories:
$ cd .. && rm -rf $LOGTALKUSER/docs/tmp*
HTML documentation for each contribution API can be found on the `docs`
directory (open the `docs/index.html` file with your web browser). The
documentation for these tools can be regenerated using the shell scripts
`../scripts/update_html_docs.sh` and `../scripts/update_svg_diagrams.sh`.
@@ -29,8 +29,11 @@ output.
Validation:
The provided unit tests are based on a collection of problemset
files from International Planning Competition 2008. in order to
files from International Planning Competition 2008. In order to
run all unit tests from the parser's directory type:
?- logtalk_load(tester).
Or from any directory by typing:
?- logtalk_load(pddl_parser(tester)).
Some of the unit tests fail in some Prolog compilers due to
limitations to the maximum arity of a term.
View
@@ -42,33 +42,10 @@ starting Logtalk. The provided Prolog POSIX integration scripts and
Windows shortcuts automate this process and should be used unless
there's a strong reason to manually load Logtalk.
HTML documentation for the core entity APIs can be found on the `docs`
directory (open the `docs/index.html` file with your web browser). The
documentation for these tools can be regenerated using the shell scripts
`../scripts/update_html_docs.sh` and `../scripts/update_svg_diagrams.sh`.
The source files are formatted using tabs (the recommended setting is
a tab width equivalent to 4 spaces).
The `$LOGTALKUSER/docs` directory includes an XHTML version of the core
entities documentation. To regenerate the documentation of these libraries,
start Logtalk with your favorite back-end Prolog compiler and follow these
steps:
(1) If the `source_data` flag is not turned `on` by default, type the query:
| ?- set_logtalk_flag(source_data, on).
(2) Load the `lgtdoc` tool and generate the XML documenting files for all
core entities using the queries:
| ?- {lgtdoc(loader)}.
...
| ?- lgtdoc::library(core, [xml_docs_directory('$LOGTALKUSER/docs/tmp')]).
(3) Run the command `lgt2html` on the `$LOGTALKUSER/docs/tmp` directory
to generate (X)HTML documentation or the command `lgt2pdf` to generate PDF
documentation. For example:
$ cd $LOGTALKUSER/docs/tmp
$ lgt2html -i core.html -t "Core entities documentation index" && mv *.html ..
After generating the (X)HTML and/or PDF documentation, you can delete the
temporary directories:
$ rm -rf $LOGTALKUSER/docs/tmp_*
View
@@ -130,36 +130,10 @@ available at:
http://www.cs.otago.ac.nz/staffpriv/ok/pllib.htm
HTML documentation for the library APIs can be found on the `docs`
directory (open the `docs/index.html` file with your web browser).
The documentation can be regenerated using the shell scripts
`../scripts/update_html_docs.sh` and `../scripts/update_svg_diagrams.sh`.
All source files are formatted using tabs (the recommended setting is a tab
width equivalent to 4 spaces).
The `$LOGTALKUSER/docs` directory includes an HTML version of the library
documentation. To regenerate documentation of the Logtalk libraries, start
Logtalk with your favorite back-end Prolog compiler and follow these steps:
(1) If the `source_data` flag is not `on` by default, type the query:
| ?- set_logtalk_flag(source_data, on).
(2) Load all library entities using the query:
| ?- {library(all_loader)}.
(3) Load the `lgtdoc` tool and generate the XML documenting files for all
library entities using the queries:
| ?- {lgtdoc(loader)}.
...
| ?- lgtdoc::rlibrary(library, [xml_docs_directory('$LOGTALKUSER/docs/tmp')]).
(4) Run the command `lgt2html` on the `$LOGTALKUSER/docs/tmp` directory
to generate (X)HTML documentation or the command `lgt2pdf` to generate PDF
documentation. For example:
$ cd $LOGTALKUSER/docs/tmp
$ lgt2html -i library.html -t "Library documentation index" && mv *.html ..
After generating the (X)HTML and/or PDF documentation, you can delete the
temporary directories:
$ rm -rf $LOGTALKUSER/docs/tmp
View
@@ -68,7 +68,7 @@ Tools documentation
-------------------
Specific notes about each tool can be found in the corresponding `NOTES.md`
files. Basic XHTML documentation about each tool can be found on the `docs`
files. HTML documentation for each tool API can be found on the `docs`
directory (open the `docs/index.html` file with your web browser). The
documentation for these tools can be regenerated using the shell scripts
`../scripts/update_html_docs.sh` and `../scripts/update_svg_diagrams.sh`.

0 comments on commit e7bbfdb

Please sign in to comment.