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 |
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 |
chat_messages/3 | Get messages associated with DocID. | |
chat_store/1 | Add a chat message to the chat store. | |
chat_count_about/2 | True when Count is the number of messages about DocID. | |
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. | |
cp_authenticate.pl -- SWISH login management |
dashboard.pl -- Provide non-programmer query execution |
parameters/1 | Fill query parameters. | |
examples.pl -- Serve example files |
provides/1 | Make examples available through swish_provides/1. | |
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 |
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_rescan/1 | Update our view of the shared storage for all stores matching Store. | |
gitty_update_head/4 | 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 |
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. | |
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 |
jquery/2 | Run a jQuery query in the SWISH interface. | |
jquery/3 | Run a jQuery query in the SWISH interface. | |
logging.pl -- Add SWISH query execution to the HTTP log file |
create_log_dir/0 | Create the directory for holding the log files. | |
create_log_dir/1 | Create the directory for holding the log files. | |
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 |
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) |
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. | |
profiles.pl |
projection.pl -- Define the projection |
projection/1 | Specify the result variables. | |
render.pl -- SWISH term-rendering support |
current_renderer/2 | True when renderer Name is declared with Comment. | |
register_renderer/2 | Register a module as SWISH rendering component. | |
use_rendering/1 | Register an answer renderer. | |
use_rendering/2 | Register an answer renderer with options. | |
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). | |
storage.pl -- Store files on behalve of web clients |
typeahead/4 | Find files using typeahead from the SWISH search box. | |
storage_file/1 | ! storage_file_extension(?File, ?Extension) is nondet. | |
storage_fsck/0 | Enumerate and check the consistency of the entire store. | |
storage_load_term/2 | Add/retrieve terms from the gitty store. | |
storage_meta_property/2 | True when Meta has Property. | |
storage_repack/0 | Repack the storage directory. | |
storage_repack/1 | Repack the storage directory. | |
storage_store_term/2 | Add/retrieve terms from the gitty store. | |
storage_unpack/0 | Unpack all packed objects of the store. | |
use_gitty_file/1 | Load a file from the Gitty store. | |
use_gitty_file/2 | Load a file from the Gitty store. | |
swish_csv.pl -- Support CSV output from a Pengines server |
write_result/3 | Hook into library(pengines) that makes pengines support CSV output. | |
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 -- |
prepare_goal/3 | Handle the breakpoints(List) option to set breakpoints prior to execution of the query. | |
open_source/2 | Open SWISH non-file sources. | |
$swish wrapper/2 | Wrap a SWISH goal in '$swish wrapper'. | |
post_context/3 | Multifile hooks to extract additional information from the Pengine, either just before Goal is started or after an answer was produced. | |
pre_context/3 | Multifile hooks to extract additional information from the Pengine, either just before Goal is started or after an answer was produced. | |