cpack.pl -- CPACK HTML components

This module defines vizualisation primitives for CPACK resources. It also hooks the local-view of ClioPatria to provide nicer pages for instances of CPACK objects such as cpack:Package.

To be done: - Use PlDoc Wiki for rendering the description. Should that be yet another package?

cliopatria:list_resource(+Pack)//[multifile]

Hook the ClioPatria local view page to create a more sensible represention of a package.

package_table(Options)// is det

Emit a table that describes Packages. Options supported:

sort_by(Column): Sort table by given column.

sort_packages(By, Packs, Sorted)[private]

Sort a list of packages by the key By.

cpack_sort_key(+KeyName, +CPACK, -KeyValue) is det[private]

KeyValue is a sort-key for sorting package by KeyName.

cpack(+Pack, +Options)// is det

Display information about Pack.

install_url_row(+Pack)//[private]

git_shortlog(+Pack, +Options)//[private]

Component that show the top-N most recent changes in Pack.

commit_info(+Pack, +Hash, +Options)//

Component to show an individual commit. Options:

diff(Diff): One of stat (default) or patch (full difference)

files_in_pack(+Pack)// is det[private]

Create a ul for all files that appear in the pack. Maybe we should consider a tree-styled nested ul?

cpack_issues(+Pack, +Problems)[private]

cpack_status_icon(+Package)// is det

Show an icon for the sanity-state of the package

cpack_update_icon(+Pack)//[private]

Show an icon to update the Pack if the current user is the submitter.

cpack_file(+FileURL, +Options)// is det[private]

Show local view for the file FileURL

prolog_file(+FileURL)// is det[private]

Describe our knowledge about a Prolog source file.

file_imports(+File)// is det[private]

Show required dependencies of this file.

used_by(+File)// is det[private]

Indicates which other files in which package depend on this file.

p_row(+R, +P)// is det[private]

Row in a propery table.

list_ul(+ItemList, +Options)[private]

Create an ul list from the items in ItemList. Options are passed as attributes to the ul element, except for:

predicate(P): Use the predicate P as preferenced prediate to generate a label.

To be done: - : Allow for sorting

list(+List, :Goal, +Type)// is det[private]

Create an HTML list from the elements of List. Each member of List is typeset in an li element by calling

call(Goal,
Member)

. Type is one of ul or ol, optionally with an extra argument that provides attributes for the list. For example:

      list(List, make_item, ul(class(mylist))),
      ...

make_item(Name, Mail) -->
      html([Name, ' <mailto:', Mail, '>']).

cpack_prop(+Resource, +Property)[private]

Display the value of Property for Resource in the current location.

To be done: - : Deal with multiple values?

cpack_wiki(+Resource, +Property)[private]

Display the value of Property for Resource in the current location, where the value is represented in wiki format.

representer(+R0, -R) is det[private]

Find representers among equivalent objects. This deals with the author case.

To be done: - Move to an OWL library

wiki(O)//[private]

Render text as Wiki

cpack_link(+R)// is det

cpack_link(+R, +P)// is det

Display a link to a CPACK resource. The version cpack_link//2 can be used to select a given property for producing the label.

rdf_label:display_label_hook(+Pack, ?Lang, -Label) is semidet[multifile]

Provide the label of a package using the cpack:packageName property.

Undocumented predicates

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

current_package(Arg1, Arg2)
cpack_prop(Arg1, Arg2, Arg3, Arg4)