lib

Prolog files

attvar.pl
get_attr/2	Get the attribute on the current module.
put_attr/2	Put an attribute on the current module.
authenticate.pl  -- Authentication access for SWISH
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
bt_button/6
bt_form/4	Emit a Bootstrap form from Contents.
name_label/2	Determine a label from a name by upcasing the first character and replacing all underscores by spaces.
chat.pl  -- The SWISH collaboration backbone
broadcast_bell/3	Adds a bell to indicate central chat messages.
chat_about/2	Distribute a chat message about DocID.
chat_broadcast/1	Send Message to all known SWISH clients.
chat_broadcast/2	Send Message to all known SWISH clients.
chat_to_profile/2	Send a HTML notification to users logged in using ProfileID.
notifications/3	The chat element is added to the navbar and managed by web/js/chat.js.
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
dashboard.pl  -- Provide non-programmer query execution
examples.pl  -- Serve example files
flags.pl
form.pl  -- Form handling utilities
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_plain_commit/3	Load the commit object with Hash.
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
attach_pack/2	Load the index of Pack into memory.
delete_head/2	Delete Head from Store.
delete_object/2	Delete an existing object.
fsck_pack/1	Validate the integrity of the pack file File.
gitty_close/1	Close resources associated with a store.
gitty_file/4	True when File entry in the gitty store and Head is the HEAD revision.
gitty_fsck/1	Validate all packs associated with Store.
gitty_hash/2	True when Hash is an object in the store.
gitty_object_file/3	True when Path is the file at which the object with Hash is stored.
gitty_open/2	Driver specific initialization.
gitty_rescan/1	Update our view of the shared storage for all stores matching Store.
gitty_update_head/5	Update the head of a gitty store for Name.
load_object/5	Load the given object.
load_object_from_pack/4	True when Hash is in a pack and can be loaded.
load_plain_commit/3	Load the commit data as a dict.
pack_objects/6	Pack the given objects and pack files into a new pack.
repack_objects/2	Repack objects of Store for reduced disk usage and enhanced performance.
set_head/3	Set the head of the given File to Hash.
store_object/4	Store the actual object.
unpack_pack/2	Turn a pack back into a plain object files.
unpack_packs/1	Unpack all packs.
help.pl  -- SWISH help system
highlight.pl  -- Highlight token server
html_output.pl  -- SWISH HTML Output
include.pl  -- Support :- include(File) from SWISH
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
swish_provides/1	True when Term describes a provided feature of the current SWISH instances.
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.
page.pl  -- Provide the SWISH application as Prolog HTML component
patch.pl  -- Run patch program
paths.pl  -- Setup SWISH search paths
pep.pl  -- SWISH PEP (Policy Enforcement Point)
not_sandboxed/2	Called by Pengines to see whether User may call non-sandboxed operations in Application.
approve/3	This hook is called by approve/2 and deny/2 before the default rules.
approve/2
authorized/2	Verify that Action is authorized.
deny/2
ws_authorized/2	True when WSUser is allowed to perform action.
procps.pl  -- Get process statistics from Linux /proc
profiles.pl
config/2	Provides the object config.swish.profiles, a JSON object that provides the available profiles.
projection.pl  -- Define the projection
render.pl  -- SWISH term-rendering support
search.pl  -- SWISH search from the navigation bar
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  -- Print debug messages and test assertions
swish_diagnostics.pl
pengine_stale_module/1	True if M seems to be a pengine module with no associated pengine.
pengine_stale_module/2	True if M seems to be a pengine module with no associated pengine.
redis_consumer_status/2	True when Status is a dict describing the current status for Consumer.
stale_pengine/1	True if Pengine is a Pengine who's thread died.
start_swish_stat_collector/0	Start collecting statistical performance information for the running SWISH server.
swish_cluster_member/2
swish_died_thread/2	True if Id is a thread that died with Status and has not (yet) been joined.
swish_save_stats/1	Save statistcs to File or the default file.
swish_statistics/1	True if State is a statistics about SWISH.
swish_stats/2	Get the collected statistics for the given Period.
swish_redis.pl  -- Redis stream connection
redis_consumer/1	True when Consumer is the name of this redis node.
reinit_redis/0	Stop and start the redis thread.
swish_cluster/1	True when Pairs is a list Consumer-URL of peer SWISH servers in this cluster.
template_hint.pl  -- Generate template hints for CondeMirror
config/2	Provides the object config.swish.templates, a JSON object that provides the templates for hinting in CodeMirror.
predicate_template/2
visible_predicate/3	True when PI is a plain predicate indicator for a predicate that can be called in Module.
visible_predicate_templates/3	True when Templates is a JSON dict holding autocompletion templates for Module.
trace.pl  --
version.pl  -- Manage software versions
check_prolog_version/1	Validate the program is running under Prolog version Required or newer.
git_module_property/2	Property is a property of the named git-component.
prolog_version_atom/1	Atom describes the current Prolog version.
register_git_module/2	Register the directory from which the Prolog file was loaded as a GIT component about which to report version information.
web.pl  -- Serve /plugin