Did you know ... Search Documentation:
examples.pl
PublicShow source
 examples(+Objs, +Options)[private]
Include examples for the predicate PI.
Source example(+PI, -File, -RefType) is nondet[private]
Get an example.
Source ex_code(File, N, Size, XRef)[private]
Source index_examples is det
Source index_examples(+Backlog) is det
Source reindex_examples is det
Update the example index.
To be done
- We only have to reprocess modified or new examples.
Source ex_xref(Id, Code, XRef) is nondet
Source ex_repo(-Dir) is nondet[private]
True when Dir is a toplevel example directory
Source ex_file(-File) is nondet[private]
True when File is the name of an example file
Source ex_file_dom(+File, -DOM) is det[private]
Source dom_code(+DOM, -Code, -Attrs) is nondet[private]
Source dom_property(+DOM, ?Prop, -ValueDOM) is nondet[private]
Source code_xref(+Code, -XRef) is det[private]
Cross-reference a code fragment
Source xref_terms(+Terms, -XRef:dict) is det[private]
Cross-reference a list of terms, returning a dict that contains:
  • defined:OrdSetOfPI
  • called:OrdSetOfPI
  • required:OrdSetOfPI
  • error:SetOfErrorTerms

Note that XRef.required is XRef.called \ built-in \XRef.defined.

Source pull_examples[private]
Do a git pull on the examples and update the index.

Undocumented predicates

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

Source reindex_examples
Source examples(Arg1, Arg2, Arg3, Arg4)