diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11441b987f7f0da64f83e6233d40293f50474a76..25dc2a9854bba08b960710417f814336aaf0a8eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,7 @@ These guidelines briefly explain how to contribute to SimpleSAMLphp effectively and consistently, making sure to keep high quality standards and making it easier for you to contribute. -<!-- {{TOC}} --> +[TOC] ## Team members Currently, the core team members are: diff --git a/docs/simplesamlphp-advancedfeatures.md b/docs/simplesamlphp-advancedfeatures.md index 138021f004023e9d00bce2e1324d3a8bf5ab70ef..90df9f49e30d5f9c9ea68205f1ecbdd48f543ae8 100644 --- a/docs/simplesamlphp-advancedfeatures.md +++ b/docs/simplesamlphp-advancedfeatures.md @@ -9,7 +9,7 @@ SimpleSAMLphp Advanced Features -<!-- {{TOC}} --> +[TOC] SimpleSAMLphp documentation --------------------------- diff --git a/docs/simplesamlphp-authproc.md b/docs/simplesamlphp-authproc.md index 188530b05a6852bd161dfbc2bf3b9c412357d9b2..e094076f785bf5d87e67bb0344572100cb833992 100644 --- a/docs/simplesamlphp-authproc.md +++ b/docs/simplesamlphp-authproc.md @@ -1,7 +1,7 @@ Authentication Processing Filters in SimpleSAMLphp ================================================== -<!-- {{TOC}} --> +[TOC] In SimpleSAMLphp, there is an API where you can *do stuff* at the IdP after authentication is complete, and just before you are sent back to the SP. The same API is available on the SP, after you have received a successful Authentication Response from the IdP and before you are sent back to the SP application. diff --git a/docs/simplesamlphp-changelog.md b/docs/simplesamlphp-changelog.md index 19042f52853671d25efea5d4be18d9a3121e790a..6360f81ddf7141dbd1f31371bb5919c5a445bd0d 100644 --- a/docs/simplesamlphp-changelog.md +++ b/docs/simplesamlphp-changelog.md @@ -1,7 +1,7 @@ SimpleSAMLphp changelog ======================= -<!-- {{TOC}} --> +[TOC] This document lists the changes between versions of SimpleSAMLphp. See the upgrade notes for specific information about upgrading. diff --git a/docs/simplesamlphp-customauth.md b/docs/simplesamlphp-customauth.md index f52f448e7c551f66b297538274406f1c82d4aac2..0b9d986b29e57ebc4509b587bb0071c459ac8617 100644 --- a/docs/simplesamlphp-customauth.md +++ b/docs/simplesamlphp-customauth.md @@ -4,7 +4,7 @@ Implementing custom username/password authentication This is a step-by-step guide for creating a custom username/password [authentication source](./simplesamlphp-authsource) for SimpleSAMLphp. An authentication source is responsible for authenticating the user, typically by getting a username and password, and looking it up in some sort of database. -<!-- {{TOC}} --> +[TOC] Create a custom module ---------------------- diff --git a/docs/simplesamlphp-database.md b/docs/simplesamlphp-database.md index 553f3d5e4f854015b031273d9b5169daa8e07c59..7563a4baae14c078c06be0671de4e1cf5ae411f2 100644 --- a/docs/simplesamlphp-database.md +++ b/docs/simplesamlphp-database.md @@ -8,7 +8,7 @@ SimpleSAML\Database --> -<!-- {{TOC}} --> +[TOC] Purpose ------- diff --git a/docs/simplesamlphp-errorhandling.md b/docs/simplesamlphp-errorhandling.md index 90c72df32f2b26f1ea2e14be25d38103963bda06..2631b69ed67a8a7e397e1be94bc681d8a9120f59 100644 --- a/docs/simplesamlphp-errorhandling.md +++ b/docs/simplesamlphp-errorhandling.md @@ -1,7 +1,7 @@ Exception and error handling in SimpleSAMLphp ============================================= -<!-- {{TOC}} --> +[TOC] This document describes the way errors and exceptions are handled in authentication sources and authentication processing filters. The basic goal is to be able to throw an exception during authentication, and then have that exception transported back to the SP in a way that the SP understands. diff --git a/docs/simplesamlphp-googleapps.md b/docs/simplesamlphp-googleapps.md index 88a6a5fc42673eedcc27fd6b18091abee3f8c837..e0ac5fc4f119f3307a8274280002f97053f9e7c4 100644 --- a/docs/simplesamlphp-googleapps.md +++ b/docs/simplesamlphp-googleapps.md @@ -9,7 +9,7 @@ Setting up a SimpleSAMLphp SAML 2.0 IdP to use with Google Workspace (G Suite / -<!-- {{TOC}} --> +[TOC] SimpleSAMLphp news and documentation ------------------------------------ diff --git a/docs/simplesamlphp-idp.md b/docs/simplesamlphp-idp.md index 23fc2b212a071df15392adf362793dc25fb9ec95..101d57076831d5849d5515fa48212b879ae0296d 100644 --- a/docs/simplesamlphp-idp.md +++ b/docs/simplesamlphp-idp.md @@ -8,7 +8,7 @@ SimpleSAMLphp Identity Provider QuickStart --> -<!-- {{TOC}} --> +[TOC] This guide will describe how to configure SimpleSAMLphp as an identity provider (IdP). You should previously have installed SimpleSAMLphp as described in [the SimpleSAMLphp installation instructions](simplesamlphp-install) diff --git a/docs/simplesamlphp-install.md b/docs/simplesamlphp-install.md index fc16ae8ac338ccea559607de99f04a5234f586d9..6790267f458bdfc1427b6aa6e9bbd92821e2dbb6 100644 --- a/docs/simplesamlphp-install.md +++ b/docs/simplesamlphp-install.md @@ -1,7 +1,7 @@ SimpleSAMLphp Installation and Configuration ============================================ -<!-- {{TOC}} --> +[TOC] This document is part of the SimpleSAMLphp documentation suite. diff --git a/docs/simplesamlphp-maintenance.md b/docs/simplesamlphp-maintenance.md index 1d99f19f777552072fc47df262afce1324f84150..5e4be54d689a7911887344adae9ffb28a3d62b02 100644 --- a/docs/simplesamlphp-maintenance.md +++ b/docs/simplesamlphp-maintenance.md @@ -8,7 +8,7 @@ SimpleSAMLphp Maintenance --> -<!-- {{TOC}} --> +[TOC] SimpleSAMLphp news and documentation ------------------------------------ diff --git a/docs/simplesamlphp-metadata-extensions-attributes.md b/docs/simplesamlphp-metadata-extensions-attributes.md index a04aef7701a7266bec97f9731342355178b9d2e9..e9374011693793bb02d2b47b18db6c0e17d1b113 100644 --- a/docs/simplesamlphp-metadata-extensions-attributes.md +++ b/docs/simplesamlphp-metadata-extensions-attributes.md @@ -7,7 +7,7 @@ SAML V2.0 Metadata Attribute Extensions http://daringfireball.net/projects/markdown/syntax --> -<!-- {{TOC}} --> +[TOC] This is a reference for the SimpleSAMLphp implementation of the [SAML V2.0 Attribute Extensions](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-attribute-ext.pdf) diff --git a/docs/simplesamlphp-metadata-extensions-rpi.md b/docs/simplesamlphp-metadata-extensions-rpi.md index a6dc868e772c3da16b1524074eecc539b17c5e64..f824f6ae275f3260c33ea4e45c9203688b5b6631 100644 --- a/docs/simplesamlphp-metadata-extensions-rpi.md +++ b/docs/simplesamlphp-metadata-extensions-rpi.md @@ -9,7 +9,7 @@ SAML V2.0 Metadata Extensions for Registration and Publication Information * Author: Jaime Perez [jaime.perez@uninett.no](mailto:jaime.perez@uninett.no) -<!-- {{TOC}} --> +[TOC] This is a reference for the SimpleSAMLphp implementation of the [SAML V2.0 Metadata Extensions for Registration and Publication Information](http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/saml-metadata-rpi-v1.0.html) diff --git a/docs/simplesamlphp-metadata-extensions-ui.md b/docs/simplesamlphp-metadata-extensions-ui.md index 10dd3aba08de0354cc3da718aed118717aeef3d3..4791bd730ed12f94b1ebfe755802614131870a18 100644 --- a/docs/simplesamlphp-metadata-extensions-ui.md +++ b/docs/simplesamlphp-metadata-extensions-ui.md @@ -9,7 +9,7 @@ SAML V2.0 Metadata Extensions for Login and Discovery User Interface * Author: Timothy Ace [tace@synacor.com](mailto:tace@synacor.com) -<!-- {{TOC}} --> +[TOC] This is a reference for the SimpleSAMLphp implementation of the [SAML V2.0 Metadata Extensions for Login and Discovery User Interface](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-metadata-ui/v1.0/sstc-saml-metadata-ui-v1.0.pdf) diff --git a/docs/simplesamlphp-metadata-pdostoragehandler.md b/docs/simplesamlphp-metadata-pdostoragehandler.md index 9a321c894dde294f56345c9ad7a31ea9617865f0..54d711643b5ac25a0fc75b3b2fac4a9ab1bfcbcb 100644 --- a/docs/simplesamlphp-metadata-pdostoragehandler.md +++ b/docs/simplesamlphp-metadata-pdostoragehandler.md @@ -8,7 +8,7 @@ PDO Metadata Storage Handler --> -<!-- {{TOC}} --> +[TOC] Introduction ------------ diff --git a/docs/simplesamlphp-modules.md b/docs/simplesamlphp-modules.md index 33f32df95b0d7b5fe371f7b152133d4b549498ea..c53527ff4d3eb68161b47b6bd7fcb5dfcddfa809 100644 --- a/docs/simplesamlphp-modules.md +++ b/docs/simplesamlphp-modules.md @@ -8,7 +8,7 @@ SimpleSAMLphp modules --> -<!-- {{TOC}} --> +[TOC] This document describes how the module system in SimpleSAMLphp works. It descibes what types of modules there are, how they are diff --git a/docs/simplesamlphp-nostate.md b/docs/simplesamlphp-nostate.md index 4f113a198c59c7fabdee39536c7ff253cd8f6927..d5b8196d78f702433354715d8f769dfde6f56174 100644 --- a/docs/simplesamlphp-nostate.md +++ b/docs/simplesamlphp-nostate.md @@ -8,7 +8,7 @@ SimpleSAMLphp. Unfortunately, it is also a generic error that can have many possible causes. This document will attempt to describe what this error actually means, and some of the situations that can cause it. -<!-- {{TOC}} --> +[TOC] What is "state information"? ---------------------------- diff --git a/docs/simplesamlphp-reference-idp-hosted.md b/docs/simplesamlphp-reference-idp-hosted.md index 2730c1178356b3403726114acc1c736541ac75d5..bd82ad1bc3e60c8d31f511e5858eac8ddca21ab4 100644 --- a/docs/simplesamlphp-reference-idp-hosted.md +++ b/docs/simplesamlphp-reference-idp-hosted.md @@ -1,7 +1,7 @@ IdP hosted metadata reference ============================= -<!-- {{TOC}} --> +[TOC] This is a reference for the metadata file `metadata/saml20-idp-hosted.php`. Both files have the following format: diff --git a/docs/simplesamlphp-reference-idp-remote.md b/docs/simplesamlphp-reference-idp-remote.md index 3d8a1437ccc0b28244d6b06aefabd45321e3aee6..8a4fb90b600bbd40e36fa2251c79c3f4991e8009 100644 --- a/docs/simplesamlphp-reference-idp-remote.md +++ b/docs/simplesamlphp-reference-idp-remote.md @@ -1,7 +1,7 @@ IdP remote metadata reference ============================= -<!-- {{TOC}} --> +[TOC] This is a reference for metadata options available for `metadata/saml20-idp-remote.php`. The file has the following format: diff --git a/docs/simplesamlphp-reference-sp-remote.md b/docs/simplesamlphp-reference-sp-remote.md index 176a714836696d607faa10859ec46269e210a99f..efcffc2e3c02582ecaa536be8a8fa1377a39c453 100644 --- a/docs/simplesamlphp-reference-sp-remote.md +++ b/docs/simplesamlphp-reference-sp-remote.md @@ -1,7 +1,7 @@ SP remote metadata reference ============================ -<!-- {{TOC}} --> +[TOC] This is a reference for metadata options available for `metadata/saml20-sp-remote.php`. Both files have the following format: diff --git a/docs/simplesamlphp-scoping.md b/docs/simplesamlphp-scoping.md index c821b30e7926bf56fbffb5f217ae14643a2c99f8..7a248b3331a3d01a51c6a4a35ab128d952310322 100644 --- a/docs/simplesamlphp-scoping.md +++ b/docs/simplesamlphp-scoping.md @@ -8,7 +8,7 @@ Scoping --> -<!-- {{TOC}} --> +[TOC] Scoping allows a service provider to specify a list of identity providers in an authnRequest to a proxying identity provider. This is an indication to the diff --git a/docs/simplesamlphp-sp-api.md b/docs/simplesamlphp-sp-api.md index 2182edac171c223fcc714f2f6c833bc4434aacc3..854a8f0275ff692de2d61ef71b102b4ec94f6a05 100644 --- a/docs/simplesamlphp-sp-api.md +++ b/docs/simplesamlphp-sp-api.md @@ -1,7 +1,7 @@ SimpleSAMLphp SP API reference ============================== -<!-- {{TOC}} --> +[TOC] This document describes the \SimpleSAML\Auth\Simple API. This is the preferred API for integrating SimpleSAMLphp with other applications. diff --git a/docs/simplesamlphp-sp.md b/docs/simplesamlphp-sp.md index f8329390eebf89c7a5b6ad170560fb03a21268bc..7191577c28f3acabbedd05d0081263fd0a73c8a5 100644 --- a/docs/simplesamlphp-sp.md +++ b/docs/simplesamlphp-sp.md @@ -1,7 +1,7 @@ SimpleSAMLphp Service Provider QuickStart ========================================= -<!-- {{TOC}} --> +[TOC] This guide will describe how to configure SimpleSAMLphp as a service provider (SP). You should previously have installed SimpleSAMLphp as described in [the SimpleSAMLphp installation instructions](simplesamlphp-install). diff --git a/docs/simplesamlphp-theming.md b/docs/simplesamlphp-theming.md index 3fbe1eecd4193475b3f62ce73bf398df89401f80..dee523d0adbc928f240cc0070e94adf6e62eaa9c 100644 --- a/docs/simplesamlphp-theming.md +++ b/docs/simplesamlphp-theming.md @@ -8,7 +8,7 @@ Theming the user interface in SimpleSAMLphp --> -<!-- {{TOC}} --> +[TOC] In SimpleSAMLphp every part that needs to interact with the user by using a web page, uses templates to present the HTML. SimpleSAMLphp comes with a default set of templates that presents a anonymous look. diff --git a/docs/simplesamlphp-translation.md b/docs/simplesamlphp-translation.md index b6cb10afc53267b5f956f6e6378cb8b64d6ac88a..e8f48af77e0113bc4930975f76e9b11916e8ae38 100644 --- a/docs/simplesamlphp-translation.md +++ b/docs/simplesamlphp-translation.md @@ -7,7 +7,7 @@ SimpleSAMLphp Translation Portal http://daringfireball.net/projects/markdown/syntax --> -<!-- {{TOC}} --> +[TOC] ## How translated terms are referred from a template diff --git a/modules/cron/docs/cron.md b/modules/cron/docs/cron.md index bddc411a56c1656cdcbaa35077069a4451207236..f6b159c6ed617d27220e57200fcff41c0b5d101a 100644 --- a/modules/cron/docs/cron.md +++ b/modules/cron/docs/cron.md @@ -8,7 +8,7 @@ Cron --> -<!-- {{TOC}} --> +[TOC] Introduction ------------