| Did you know ... | Search Documentation: |
 | Title for pldoc(dir_index) |
- HOME
- DOWNLOAD
- DOCUMENTATION
- TUTORIALS
- Beginner▶
- Advanced▶
- Web applications▶
- Semantic web▶
- Graphics▶
- Machine learning▶
- External collections▶
- For packagers▶
- COMMUNITY
- COMMERCIAL
- WIKI
The SWI-Prolog web-site
This repository contains the software of http://www.swi-prolog.org. The (wiki) content of the website and required add-ons are stored in git submodules. These must be installed separately using the command below. To install the site from scratch locally, perform the following commands:
- Downloading the site
% git clone https://github.com/SWI-Prolog/plweb.git % cd plweb % git submodule update --init
- For a full installation, install the dynamic data. The .db
files must be writeable by the server process.
<dl> <dt>annotations.db</dt> <dd>Comments on web pages</dd> <dt>tags.db</dt> <dd>Tags on web pages</dd> <dt>openid.db</dt> <dd>User administration</dd> <dt>packs.db</dt> <dd>Known packages</dd> <dt>post.db</dt> <dd>News posts</dd> <dt>reviews.db</dt> <dd>Pack reviews</dd> <dt>download</dt> <dd>Points to the download directory</dd> </dl>
Install the download descriptions by running the script
install-custom - Create directories for logging and pack mirrors. These
directories must be writeable by the server and new directories
created below must have the same permissions:
% mkdir log pack % chgrp www-data log pack % chmod g+ws log pack
Running the site
After installation, the website may be started locally using the commands below. After that, you have access to the same content as available from https://www.swi-prolog.org, except for the download section of the website.
% swipl load.pl -p 8080 -i
Running as daemon using Ubuntu upstart
A good way to run the website on a Linux server is by creating a Linux
container using lxc. After installing the server, you can enable it to
start at boot time by copying upstart/swi-prolog.conf to `/etc/init`
after editing it to suit your configuration requirements. By default,
the server runs as user www-data, group www-data as specified in the
above configuration file.
Make sure the following components are writeable to the server process. For files, this means mode 664, group www-data. For directories, this means mode 2775, group www-data.
- log Write httpd.log and pack-warnings.log
- pack Mirrors known packages. Will be populated as the server is started.
- www: subdirectories and .txt files
Needs to make the wiki pages editable. It is also wise to do this in
a git branch. From the www directory, do:
% git checkout master % git pull % git checkout -b wiki % find . -type d | xargs chmod 2775 % find . -name '*.txt' | xargs chmod 664 % chgrp -W www-data .
- *.db
Issues with the locally running site
- There is no download section (but that can't be a big issue)
- If you want to use the login facility to play with the
interactive aspects of the site, you need to
- Get a reCAPTCHA key-pair from Google
- Run (from a started server)
?- set_setting(recaptcha:public_key, 'public key goes here'). ?- set_setting(recaptcha:private_key, 'private key goes here'). ?- save_settings.
- Run the server from a port that is accessible from the public internet.
- Use an OpenID provider that is not too picky for your site. In our experience, Google is less picky than Yahoo.
Prolog files
annotation.pl -- Annotation | ||
|---|---|---|
| api.pl | ||
| autocomplete.pl -- SWI-Prolog website autocompletion support | ||
| blog.pl | ||
| changelog.pl | ||
| customise.pl | ||
| daemon.pl | ||
| did_you_know.pl -- Interesting snippets about SWI-Prolog | ||
| did_you_know/2 | Generate a DYK fragment. | |
| did_you_know_script/3 | Emit script to fetch DYK through AJAX. | |
| download.pl | ||
| examples.pl | ||
| ex_xref/3 | | |
| index_examples/0 | Update the example index. | |
| reindex_examples/0 | Update the example index. | |
| fastly.pl -- Purge pages on our CDN | ||
| purge_location/1 | Send a purge request for a Fastly URL. | |
| footer.pl -- Footer | ||
| footer/3 | Emit the footer, which contains the community content, server address and user information. | |
| server_information/2 | Emit server information. | |
| forum.pl | ||
| generics.pl -- Generics | ||
| is_empty/1 | | |
| request_to_id/3 | True when Request is a request to the post service for the given Kind and Id. | |
| uri_query_add/4 | Inserts the given name-value pair as a query component into the given URI. | |
| wiki_file_codes_to_dom/3 | DOM is the HTML dom representation for Codes that originate from File. | |
| git_html.pl | ||
| git_commit_info/5 | Component to show an individual commit. | |
| git_shortlog/4 | Component that show the top-N most recent changes in Pack. | |
| gitweb.pl -- Provide gitweb support | ||
| holidays.pl | ||
| http_cgi.pl -- Run CGI scripts from the SWI-Prolog web-server | ||
| load.pl | ||
| make.pl | ||
| markdown.pl -- Parse markdown documents into a DOM | ||
| markitup.pl -- Wrapper for markItUp ajax markup editor | ||
| messages.pl -- Run goals that produce messages | ||
| call_showing_messages/2 | Execute Goal, showing the feedback in the browser. | |
| news.pl -- News on the SWI-Prolog Web site | ||
| notify.pl -- Send notications by E-mail | ||
| object_support.pl -- Object support | ||
| openid.pl -- Handle users of the SWI-Prolog website | ||
| pack.pl | ||
| pack_analyzer.pl -- Analyse the content of a Prolog pack | ||
| pack_analysis/2 | Result is the analysis result for Pack. | |
| pack_members/2 | Members is a list of file(File,Size) that represent the files in Pack. | |
| pack_open_entry/3 | Open an entry in the Pack for reading. | |
| xref_pack/1 | Run the cross-referencer on all Prolog files inside pack. | |
| xref_pack_file/2 | Run the cross-referencer on File inside Pack. | |
| xref_open_source/2 | If Id refers to a known Prolog pack, open the pack entry. | |
| xref_source_file/3 | | |
| xref_source_identifier/2 | | |
| pack_info.pl -- Visual (web) components that show info about packs | ||
| clean_pack_info/1 | Remove the collected info for Pack. | |
| pack_file_details/3 | Reply with an web-page with details on File in Pack. | |
| pack_file_hierarchy/3 | Create a ul for all files that appear in the pack. | |
| pack_readme/3 | Insert readme information if provided. | |
| update_pack_metadata/0 | Destroy and recompute all pack meta-data. | |
| update_pack_metadata_in_background/0 | Destroy and recompute all pack meta-data. | |
| pack_mirror.pl -- Mirror pack archives | ||
| page.pl | ||
| github_actions/3 | Emit the github star and sponsor buttons. | |
| doc_page_header/4 | Called to render the PlDoc page header and link menu. | |
| body/4 | Provide the page skin. | |
| parms.pl | ||
| plweb.pl -- Server for PlDoc wiki pages and SWI-Prolog website | ||
| post.pl -- Posts | ||
| proxy.pl | ||
| rating.pl -- Provide a star-rating widget | ||
| register.pl | ||
| review.pl -- Handle rating and reviewing of packages | ||
| pack_comment_count/2 | True when Count is the number of comments for Pack. | |
| pack_rating_votes/3 | Rating is the current rating for Pack, based on Votes. | |
| pack_reviews/3 | Show reviews for Pack. | |
| profile_reviews/3 | Create a h2 section with all reviews by a given OpenID. | |
| show_pack_rating/3 | Show overall rating. | |
| show_pack_rating/7 | Show rating for Pack. | |
| user_review_count/2 | True when Count is the number of reviews by UUID. | |
| stats.pl -- Server statistics components | ||
| tagit.pl | ||
| ac_object/3 | Provide additional autocompletion matches on tags,. | |
| tagit_footer/4 | Show tagit widget for adding and deleting tags. | |
| user_tags/4 | Show all tags created by a given user. | |
| test_recaptcha.pl | ||
| tests.pl | ||
| update.pl | ||
| db_sync_thread/1 | Sync the persistency database every Time seconds. | |
| watchdog.pl | ||
| well_known.pl | ||
| wiki.pl | ||
| wiki_edit.pl -- Edit PlDoc wiki pages | ||