Did you know ... Search Documentation:
doc_html.pl -- PlDoc HTML backend
PublicShow source

This module translates the Herbrand term from the documentation extracting module doc_wiki.pl into HTML+CSS.

To be done
- Split put generation from computation as computation is reusable in other backends.
Source doc_for_file(+File, +Options) is det
HTTP handler that writes documentation for File as HTML. Options:
If true (default), only emit documentation for exported predicates.
If true, provide edit buttons. Default, these buttons are suppressed.
Specify the page title. Default is the base name of the file.
File- Prolog file specification or xref source id.

Undocumented predicates

The following predicates are exported, but not or incorrectly documented.

Source nopredref(Arg1, Arg2, Arg3)
Source is_op_type(Arg1, Arg2)
Source pred_edit_button(Arg1, Arg2, Arg3, Arg4)
Source doc_write_html(Arg1, Arg2, Arg3)
Source object_footer(Arg1, Arg2, Arg3, Arg4)
Source file(Arg1, Arg2, Arg3, Arg4)
Source doc_hide_private(Arg1, Arg2, Arg3)
Source object_page_header(Arg1, Arg2, Arg3, Arg4)
Source ensure_doc_objects(Arg1)
Source private(Arg1, Arg2)
Source term(Arg1, Arg2, Arg3, Arg4, Arg5)
Source source_button(Arg1, Arg2, Arg3, Arg4)
Source is_pi(Arg1)
Source object_page(Arg1, Arg2, Arg3, Arg4)
Source mode_anchor_name(Arg1, Arg2)
Source object_tree(Arg1, Arg2, Arg3, Arg4, Arg5)
Source object_href(Arg1, Arg2)
Source cite(Arg1, Arg2, Arg3)
Source edit_button(Arg1, Arg2, Arg3, Arg4)
Source doc_tag_title(Arg1, Arg2)
Source file(Arg1, Arg2, Arg3)
Source unquote_filespec(Arg1, Arg2)
Source object_ref(Arg1, Arg2, Arg3, Arg4)
Source object_source_button(Arg1, Arg2, Arg3, Arg4)
Source doc_page_dom(Arg1, Arg2, Arg3)
Source object_edit_button(Arg1, Arg2, Arg3, Arg4)
Source tags(Arg1, Arg2, Arg3)
Source flagref(Arg1, Arg2, Arg3)
Source object_synopsis(Arg1, Arg2, Arg3, Arg4)
Source module_info(Arg1, Arg2, Arg3)
Source multifile(Arg1, Arg2)
Source doc_for_wiki_file(Arg1, Arg2)
Source zoom_button(Arg1, Arg2, Arg3, Arg4)
Source pred_anchor_name(Arg1, Arg2, Arg3)
Source object_name(Arg1, Arg2, Arg3, Arg4)
Source doc_file_objects(Arg1, Arg2, Arg3, Arg4, Arg5)
Source object_page_footer(Arg1, Arg2, Arg3, Arg4)
Source predref(Arg1, Arg2, Arg3)
Source objects(Arg1, Arg2, Arg3, Arg4)
Source print_html_head(Arg1)
Source include(Arg1, Arg2, Arg3, Arg4, Arg5)
Source doc_resources(Arg1, Arg2, Arg3)
Source file_header(Arg1, Arg2, Arg3, Arg4)
Source existing_linked_file(Arg1, Arg2)
Source predref(Arg1, Arg2, Arg3, Arg4)