lib

Prolog files

attvar.pl
authenticate.pl  -- Authentication access for SWISH
authentication_hook/3	Is called from the /pengine/create request to establish the logged in user.
authenticate/2	Establish the identity behind the HTTP Request.
user_property/2	True when Identity has Property.
avatar.pl  -- Avatar management
random_avatar/1	Generate a random avatar image url.
release_avatar/1	Release the avatar to the pool of free avatars.
valid_gravatar/1	True if URL is a real gravatar.
bootstrap.pl  -- Bootstrap form generator
chat.pl  -- The SWISH collaboration backbone
chatstore.pl  -- Store chat messages
config.pl  -- Make HTTP locations known to JSON code
config/2	Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).
login/2	If a login item with 'data-server'(+Server) is clicked, the HTTP handler with id login is called.
login_item/2	This hook is called to find all possible login options.
source_alias/2	Multifile hook that defines properties of file_search_path/2 aliases wrt.
swish_config/2	Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).
swish_config_hash/2	True if Hash is the SHA1 of the SWISH config.
swish_reply_config/2	Emit a configuration object to the client if the client requests for '.../swish_config.json', regardless of the path prefix.
user_info/3	Each login facility must provide this hook.
content_filter.pl  -- Ban list content filter
eval_content/3	Evaluate the content of Text.
dashboard.pl  -- Provide non-programmer query execution
examples.pl  -- Serve example files
flags.pl
form.pl  -- Form handling utilities
validate_field/4	True when Value is a valid value for Field from Dict according to Options.
validate_form/2	Run validate_field/4 on all specified fields, combining the error message.
gitty.pl  -- Single-file GIT like version system
data_diff/3	Diff two data strings line-by-line.
delete_head/2	Delete Head from the administration.
delete_object/2	Delete an existing object.
fsck_object/2	Test the integrity of object Hash in Store.
gitty_close/1	Close access to the Store.
gitty_commit/3	True if Meta holds the commit data of NameOrHash.
gitty_create/5	Create a new object Name from Data and meta information.
gitty_data/4	Get the data in object Name and its meta-data.
gitty_diff/4	True if Dict representeds the changes in Hash1 to FileOrHash2.
gitty_driver/2	Get the current gitty driver.
gitty_file/3	True when Hash is an entry in the gitty Store and Head is the HEAD revision.
gitty_file/4	True when Hash is an entry in the gitty Store and Head is the HEAD revision.
gitty_fsck/1	Check the integrity of store.
gitty_hash/2	True when Hash is an object in the store.
gitty_history/4	History is a dict holding a key history with a list of dicts representating the history of Name in Store.
gitty_load/4	Low level objects store.
gitty_open/2	Open a gitty store according to Options.
gitty_reserved_meta/1	True when Key is a gitty reserved key for the commit meta-data.
gitty_save/4	Low level objects store.
gitty_update/5	Update document Name using Data and the given meta information.
is_gitty_hash/1	True if Term is a possible gitty (SHA1) hash.
set_head/3	Register Head as the Head hash for File, removing possible old head.
udiff_string/2	True when String is the string representation of UDiff.
gitty_driver_bdb.pl  -- Gitty BDB driver
delete_head/2	Delete the named head.
delete_object/2	Delete an existing object.
gitty_close/1	Close the BDB environment associated with a gitty store.
gitty_file/3	True when File entry in the gitty store and Head is the HEAD revision.
gitty_hash/2	True when Hash is an object in the store.
gitty_update_head/4	Update the head of a gitty store for Name.
load_object/5	Load an object given its Hash.
load_plain_commit/3	Load the commit data as a dict.
set_head/3	Set the head of the given File to Hash.
store_object/4	Store the actual object.
gitty_driver_files.pl  -- Gitty plain files driver
help.pl  -- SWISH help system
highlight.pl  -- Highlight token server
xref_open_source/2	Open a source.
config/2	Provides the object config.swish.style, a JSON object that maps style properties of user-defined extensions of library(prolog_colour).
css/3	Multifile hook to define additional style to apply in a specific context.
current_highlight_state/2	Return info on the current highlighter.
server_tokens/1	These predicates help debugging the server side.
show_mirror/1	These predicates help debugging the server side.
style/3	Declare that we map StyleIn as generated by library(prolog_colour) into a token of type SWISHType, providing additional context information based on Attributes.
token_info/3	Generate HTML, providing details about Token.
html_output.pl  -- SWISH HTML Output
html/1	Insert HTML into the output.
html/3	Sandbox respecting version of html_write:html//1.
safe_raw_html/1	Helper for variables in html(\List).
include.pl  -- Support :- include(File) from SWISH
xref_source_file/3	Deal with the above expansion for :- include(program) to support the cross-referencer.
xref_source_identifier/2	Map swish://file to a file from the gitty store.
include/2	Include file at a specific version.
jquery.pl  -- Call jQuery on the SWISH interface
markdown.pl  -- SWISH Notebook markdown support
file/4	Hook that deals with linking other notebooks using the following markdown syntax:.
md_eval.pl  -- Provide evaluable markdown
messages.pl
noble_avatar.pl  -- Noble Avatar generator
create_avatar/2	(Re-)create avatar with basename PNG.
existing_noble_avatar/2	True when Image is the image file of a previously generated avatar of Gender.
noble_avatar/2	True when File is the image file name for a generated avatar of Gender.
noble_avatar/3	True when File is the image file name for a generated avatar of Gender.
oauth2.pl  -- Oauth2 based login
login/3	Multifile hook to realise the actual login.
oauth2_claim/2	True when Claim is the claim made in TokenInfo.
oauth2_login/2	HTTP handler to login using oauth2.
oauth2_reply/2	HTTP handler for the redirect we get back from the oauth2 server.
oauth2_user_info/3	Given the token details obtained in oauth2_reply/2, get extended information about the user from the identity provider.
oauth2_validate_access_token/3	Validates the AccessToken with Unity (implicit or hybrid flow).
server_attribute/3	Multifile hook that defines available oauth2 servers.
page.pl  -- Provide the SWISH application as Prolog HTML component
logo/3	Hook to include the top-left logos.
pengine_logo/3	Emit an <a> element that provides a link to Pengines and SWISH on this server.
swish_content/3	Generate the SWISH editor, Prolog output area and query editor.
swish_logo/3	Emit an <a> element that provides a link to Pengines and SWISH on this server.
swish_navbar/3	Generate the swish navigation bar.
swish_page/3	Generate the entire SWISH default page.
swish_reply/2	HTTP handler to reply the default SWISH page.
swish_reply_resource/1	Serve /swish/Resource files.
swish_resources/2	Include SWISH CSS and JavaScript.
patch.pl  -- Run patch program
patch/4	Patch the string Orig using Diff.
paths.pl  -- Setup SWISH search paths
pep.pl  -- SWISH PEP (Policy Enforcement Point)
procps.pl
profiles.pl
projection.pl  -- Define the projection
render.pl  -- SWISH term-rendering support
search.pl  -- SWISH search from the navigation bar
match/3	True if Line matches Query, respecting Options.
search_box/3	Render a Bootstrap search box.
typeahead/4	Find typeahead suggestions for a specific search category (Type).
session.pl  -- Setup SWISH sessions
storage.pl  -- Store files on behalve of web clients
swish_chr.pl  -- Make CHR available in SWISH
swish_csv.pl  -- Support CSV output from a Pengines server
swish_debug.pl
template_hint.pl  -- Generate template hints for CondeMirror
trace.pl  --
version.pl  -- Manage software versions
web.pl  -- Serve /plugin