SWI-Prolog 9.3.29
All Application Manual Name SummaryHelp

lib

Prolog files

attvar.plShow source
get_attr/2Get the attribute on the current module.Source
put_attr/2Put an attribute on the current module.Source
authenticate.pl  -- Authentication access for SWISHShow source
authentication_hook/3Is called from the /pengine/create request to establish the logged in user.Source
authenticate/2Establish the identity behind the HTTP Request.Source
user_property/2True when Identity has Property.Source
avatar.pl  -- Avatar managementShow source
bootstrap.pl  -- Bootstrap form generatorShow source
chat.pl  -- The SWISH collaboration backboneShow source
broadcast_bell/3Adds a bell to indicate central chat messages.Source
chat_about/2Distribute a chat message about DocID.Source
chat_broadcast/1Send Message to all known SWISH clients.Source
chat_broadcast/2Send Message to all known SWISH clients.Source
chat_to_profile/2Send a HTML notification to users logged in using ProfileID.Source
notifications/3The chat element is added to the navbar and managed by web/js/chat.js.Source
chatstore.pl  -- Store chat messagesShow source
chat_messages/3Get messages associated with DocID.Source
chat_store/1Add a chat message to the chat store.Source
chat_count_about/2True when Count is the number of messages about DocID.Source
config.pl  -- Make HTTP locations known to JSON codeShow source
config/2Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).Source
login/2If a login item with 'data-server'(+Server) is clicked, the HTTP handler with id login is called.Source
login_item/2This hook is called to find all possible login options.Source
source_alias/2Multifile hook that defines properties of file_search_path/2 aliases wrt.Source
swish_config/2Define a name/value pair that will end up in the SWISH config object (see web/js/config.js).Source
swish_config_hash/2True if Hash is the SHA1 of the SWISH config.Source
swish_reply_config/2Emit a configuration object to the client if the client requests for '.../swish_config.json', regardless of the path prefix.Source
user_info/3Each login facility must provide this hook.Source
content_filter.pl  -- Ban list content filterShow source
eval_content/3Evaluate the content of Text.Source
dashboard.pl  -- Provide non-programmer query executionShow source
examples.pl  -- Serve example filesShow source
flags.plShow source
form.pl  -- Form handling utilitiesShow source
gitty.pl  -- Single-file GIT like version systemShow source
data_diff/3Diff two data strings line-by-line.Source
delete_head/2Delete Head from the administration.Source
delete_object/2Delete an existing object.Source
fsck_object/2Test the integrity of object Hash in Store.Source
gitty_close/1Close access to the Store.Source
gitty_commit/3True if Meta holds the commit data of NameOrHash.Source
gitty_create/5Create a new object Name from Data and meta information.Source
gitty_data/4Get the data in object Name and its meta-data.Source
gitty_diff/4True if Dict representeds the changes in Hash1 to FileOrHash2.Source
gitty_driver/2Get the current gitty driver.Source
gitty_file/3True when Hash is an entry in the gitty Store and Head is the HEAD revision.Source
gitty_file/4True when Hash is an entry in the gitty Store and Head is the HEAD revision.Source
gitty_fsck/1Check the integrity of store.Source
gitty_hash/2True when Hash is an object in the store.Source
gitty_history/4History is a dict holding a key history with a list of dicts representating the history of Name in Store.Source
gitty_load/4Low level objects store.Source
gitty_open/2Open a gitty store according to Options.Source
gitty_plain_commit/3Load the commit object with Hash.Source
gitty_reserved_meta/1True when Key is a gitty reserved key for the commit meta-data.Source
gitty_save/4Low level objects store.Source
gitty_update/5Update document Name using Data and the given meta information.Source
is_gitty_hash/1True if Term is a possible gitty (SHA1) hash.Source
set_head/3Register Head as the Head hash for File, removing possible old head.Source
udiff_string/2True when String is the string representation of UDiff.Source
gitty_driver_bdb.pl  -- Gitty BDB driverShow source
gitty_driver_files.pl  -- Gitty plain files driverShow source
help.pl  -- SWISH help systemShow source
highlight.pl  -- Highlight token serverShow source
xref_open_source/2Open a source.Source
config/2Provides the object config.swish.style, a JSON object that maps style properties of user-defined extensions of library(prolog_colour).Source
css/3Multifile hook to define additional style to apply in a specific context.Source
current_highlight_state/2Return info on the current highlighter.Source
server_tokens/1These predicates help debugging the server side.Source
show_mirror/1These predicates help debugging the server side.Source
style/3Declare that we map StyleIn as generated by library(prolog_colour) into a token of type SWISHType, providing additional context information based on Attributes.Source
token_info/3Generate HTML, providing details about Token.Source
html_output.pl  -- SWISH HTML OutputShow source
html/1Insert HTML into the output.Source
html/3Sandbox respecting version of html//1.Source
safe_raw_html/1Helper for variables in html(\List).Source
include.pl  -- Support :- include(File) from SWISHShow source
xref_source_file/3Deal with the above expansion for :- include(program) to support the cross-referencer.Source
xref_source_identifier/2Map swish://file to a file from the gitty store.Source
include/2Include file at a specific version.Source
jquery.pl  -- Call jQuery on the SWISH interfaceShow source
jquery/2Run a jQuery query in the SWISH interface.Source
jquery/3Run a jQuery query in the SWISH interface.Source
markdown.pl  -- SWISH Notebook markdown supportShow source
file/4Hook that deals with linking other notebooks using the following markdown syntax:.Source
md_eval.pl  -- Provide evaluable markdownShow source
messages.plShow source
noble_avatar.pl  -- Noble Avatar generatorShow source
create_avatar/2(Re-)create avatar with basename PNG.Source
existing_noble_avatar/2True when Image is the image file of a previously generated avatar of Gender.Source
noble_avatar/2True when File is the image file name for a generated avatar of Gender.Source
noble_avatar/3True when File is the image file name for a generated avatar of Gender.Source
page.pl  -- Provide the SWISH application as Prolog HTML componentShow source
patch.pl  -- Run patch programShow source
paths.pl  -- Setup SWISH search pathsShow source
pep.pl  -- SWISH PEP (Policy Enforcement Point)Show source
not_sandboxed/2Called by Pengines to see whether User may call non-sandboxed operations in Application.Source
approve/3This hook is called by approve/2 and deny/2 before the default rules.
approve/2Source
authorized/2Verify that Action is authorized.Source
deny/2Source
ws_authorized/2True when WSUser is allowed to perform action.Source
procps.pl  -- Get process statistics from Linux /procShow source
procps_stat/1Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.Source
procps_stat/2Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.Source
procps_status/1Get the data from /proc/self/status as a Prolog dict.Source
procps_status/2Get the data from /proc/self/status as a Prolog dict.Source
procps_thread_stat/2Get data from the stat file of the current process, the process identified by PID or the Prolog thread identified by Thread.Source
profiles.plShow source
projection.pl  -- Define the projectionShow source
render.pl  -- SWISH term-rendering supportShow source
search.pl  -- SWISH search from the navigation barShow source
session.pl  -- Setup SWISH sessionsShow source
storage.pl  -- Store files on behalve of web clientsShow source
swish_chr.pl  -- Make CHR available in SWISHShow source
swish_csv.pl  -- Support CSV output from a Pengines serverShow source
write_result/3Hook into library(pengines) that makes pengines support CSV output.Source
swish_debug.pl  -- Print debug messages and test assertionsShow source
debug/1Add/remove a topic from being printed.Source
list_debug_topics/0List currently known topics for debug/3 and their setting.Source
list_debug_topics/1List currently known topics for debug/3 and their setting.Source
nodebug/1Add/remove a topic from being printed.Source
swish_debug/3Format a message if debug topic is enabled.Source
swish_debugging/1Examine debug topics.Source
swish_diagnostics.plShow source
swish_redis.pl  -- Redis stream connectionShow source
template_hint.pl  -- Generate template hints for CondeMirrorShow source
trace.pl  -- Show source
version.pl  -- Manage software versionsShow source
check_prolog_version/1Validate the program is running under Prolog version Required or newer.Source
git_module_property/2Property is a property of the named git-component.Source
prolog_version_atom/1Atom describes the current Prolog version.Source
register_git_module/2Register the directory from which the Prolog file was loaded as a GIT component about which to report version information.Source
web.pl  -- Serve /pluginShow source