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 |
|---|
| 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 |
|---|
| data_source.pl -- Cached data access |
|---|
| download.pl -- Provide a button for downloading data |
|---|
| download_button/2 | Emit a button in the SWISH output window for downloading Data. | |
| examples.pl -- Serve example files |
|---|
| provides/1 | Make examples available through swish_provides/1. | |
| 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_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 |
|---|
| 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). | |
| http_version.pl -- Serve version details over HTTP |
|---|
| 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 |
|---|
| 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 |
|---|
| 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 |
|---|
| patch.pl -- Run patch program |
|---|
| paths.pl -- Setup SWISH search paths |
|---|
| pep.pl -- SWISH PEP (Policy Enforcement Point) |
|---|
| procps.pl -- Get process statistics from Linux /proc |
|---|
| profiles.pl |
|---|
| projection.pl -- Define the projection |
|---|
| r_swish.pl |
|---|
| r_console/2 | Relay Rserve captured output to SWISH using writeln. | |
| r_console_property/1 | Relay the size of the console. | |
| r_display_images/1 | Relay received images to the SWISH console using pengine_output/1. | |
| r_download/0 | Provide download buttons for all created files. | |
| r_download/1 | Provide a download button for the indicates file. | |
| 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 |
|---|
| typeahead/4 | Find files using typeahead from the SWISH search box. | |
| storage_commit/2 | Load the commit data for Hash. | |
| storage_file/1 | True if File is known in the store. | |
| storage_file/3 | True if File is known in the store. | |
| storage_file_extension/2 | True if File is known in the store. | |
| storage_file_extension_head/3 | True if File is known in the store. | |
| 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_data/2 | True if File is known in the 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_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 |
|---|
| swish_redis.pl -- Redis stream connection |
|---|
| 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 -- |
|---|
| tutorial.pl |
|---|
| version.pl -- Manage software versions |
|---|
| web.pl -- Serve /plugin |
|---|