From f2124094cd612852fe17b483d3665711c8d86549 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20=C3=85kre=20Solberg?= <andreas.solberg@uninett.no>
Date: Mon, 8 Mar 2010 10:14:12 +0000
Subject: [PATCH] Adding table of content tag to documentation
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@2206 44740490-163a-0410-bde0-09ae8108e29a
---
docs/simplesamlphp-advancedfeatures.txt | 2 ++
docs/simplesamlphp-authproc.txt | 3 +++
docs/simplesamlphp-automated_metadata.txt | 1 +
docs/simplesamlphp-changelog.txt | 1 +
docs/simplesamlphp-errorhandling.txt | 2 ++
docs/simplesamlphp-features.txt | 2 ++
docs/simplesamlphp-googleapps.txt | 1 +
docs/simplesamlphp-idp-more.txt | 1 +
docs/simplesamlphp-idp.txt | 2 ++
docs/simplesamlphp-install.txt | 1 +
docs/simplesamlphp-maintenance.txt | 2 +-
docs/simplesamlphp-modules.txt | 1 +
docs/simplesamlphp-reference-idp-hosted.txt | 2 ++
docs/simplesamlphp-reference-idp-remote.txt | 2 ++
docs/simplesamlphp-reference-sp-hosted.txt | 2 ++
docs/simplesamlphp-reference-sp-remote.txt | 2 ++
docs/simplesamlphp-sp-api.txt | 2 ++
docs/simplesamlphp-sp-migration.txt | 2 ++
docs/simplesamlphp-sp.txt | 1 +
docs/simplesamlphp-theming.txt | 1 +
docs/simplesamlphp-translation.txt | 2 ++
docs/simplesamlphp-ukaccess.txt | 1 +
22 files changed, 35 insertions(+), 1 deletion(-)
diff --git a/docs/simplesamlphp-advancedfeatures.txt b/docs/simplesamlphp-advancedfeatures.txt
index 8935185fe..b34a9a7e6 100644
--- a/docs/simplesamlphp-advancedfeatures.txt
+++ b/docs/simplesamlphp-advancedfeatures.txt
@@ -10,6 +10,8 @@ simpleSAMLphp Advanced Features
* Version: `$Id$`
+<!-- {{TOC}} -->
+
simpleSAMLphp documentation
---------------------------
diff --git a/docs/simplesamlphp-authproc.txt b/docs/simplesamlphp-authproc.txt
index f169294ff..df3700c56 100644
--- a/docs/simplesamlphp-authproc.txt
+++ b/docs/simplesamlphp-authproc.txt
@@ -9,6 +9,9 @@ Authentication Processing Filters in SimpleSAMLphp
* Version: `$Id$`
+<!-- {{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 successfull Authentication Response from the IdP and before you are sent back to the SP application.
Authentication processing filters postprocesses authentication information received from authentication sources. It is possible to use this for additional authentication checks, requesting the users consent before delivering attributes to the user, modifying the users attributes, and other things which should be performed before returning the user to the service provider he came from.
diff --git a/docs/simplesamlphp-automated_metadata.txt b/docs/simplesamlphp-automated_metadata.txt
index 9411c232e..8cfd4d763 100644
--- a/docs/simplesamlphp-automated_metadata.txt
+++ b/docs/simplesamlphp-automated_metadata.txt
@@ -9,6 +9,7 @@ Automated Metadata Management
* Version: `$Id$`
+<!-- {{TOC}} -->
Introduction
------------
diff --git a/docs/simplesamlphp-changelog.txt b/docs/simplesamlphp-changelog.txt
index dbe756ed5..5c19b4ff2 100644
--- a/docs/simplesamlphp-changelog.txt
+++ b/docs/simplesamlphp-changelog.txt
@@ -1,6 +1,7 @@
simpleSAMLphp changelog
=======================
+<!-- {{TOC}} -->
Here is changes between simpleSAMLphp versions. Look here if you are upgrading, to see if there are any changes to the config format.
diff --git a/docs/simplesamlphp-errorhandling.txt b/docs/simplesamlphp-errorhandling.txt
index 0b5cc602b..6d705f69e 100644
--- a/docs/simplesamlphp-errorhandling.txt
+++ b/docs/simplesamlphp-errorhandling.txt
@@ -9,6 +9,8 @@ Exception and error handling in simpleSAMLphp
* Version: `$Id$`
+<!-- {{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-features.txt b/docs/simplesamlphp-features.txt
index d3b1d5750..ba4a781f0 100644
--- a/docs/simplesamlphp-features.txt
+++ b/docs/simplesamlphp-features.txt
@@ -9,6 +9,8 @@ SimpleSAMLphp Features
* Version: `$Id`
+<!-- {{TOC}} -->
+
## Automatic Metadata Retrieval
SimpleSAMLphp supports regurlarly downloading SAML metadata form a HTTP location, optionally validating the signature on the metadata, and then cache the metadata to be used by a SP or IdP. Shibboleth introduced this functionality, and SimpleSAMLphp implements it in a compatible way.
diff --git a/docs/simplesamlphp-googleapps.txt b/docs/simplesamlphp-googleapps.txt
index 24bcc7db8..cf134d6ce 100644
--- a/docs/simplesamlphp-googleapps.txt
+++ b/docs/simplesamlphp-googleapps.txt
@@ -10,6 +10,7 @@ Setting up a simpleSAMLphp SAML 2.0 IdP to use with Google Apps for Education
* Version: `$Id$`
+<!-- {{TOC}} -->
simpleSAMLphp news and documentation
------------------------------------
diff --git a/docs/simplesamlphp-idp-more.txt b/docs/simplesamlphp-idp-more.txt
index b16966768..fe28c2376 100644
--- a/docs/simplesamlphp-idp-more.txt
+++ b/docs/simplesamlphp-idp-more.txt
@@ -9,6 +9,7 @@ SimpleSAMLphp Identity Provider Advanced Topics
* Version: `$Id$`
+<!-- {{TOC}} -->
AJAX iFrame Single Log-Out
--------------------------
diff --git a/docs/simplesamlphp-idp.txt b/docs/simplesamlphp-idp.txt
index 648fd9d21..51baf9b74 100644
--- a/docs/simplesamlphp-idp.txt
+++ b/docs/simplesamlphp-idp.txt
@@ -9,6 +9,8 @@ SimpleSAMLphp Identity Provider QuickStart
* Version: `$Id$`
+<!-- {{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](http://rnd.feide.no/content/installing-simplesamlphp)
diff --git a/docs/simplesamlphp-install.txt b/docs/simplesamlphp-install.txt
index ac99cd3de..dcad81c47 100644
--- a/docs/simplesamlphp-install.txt
+++ b/docs/simplesamlphp-install.txt
@@ -10,6 +10,7 @@ simpleSAMLphp Installation and Configuration
* Version: `$Id$`
+<!-- {{TOC}} -->
simpleSAMLphp news and documentation
------------------------------------
diff --git a/docs/simplesamlphp-maintenance.txt b/docs/simplesamlphp-maintenance.txt
index 19c62c404..cc9f86162 100644
--- a/docs/simplesamlphp-maintenance.txt
+++ b/docs/simplesamlphp-maintenance.txt
@@ -9,7 +9,7 @@ simpleSAMLphp Maintenance
* Version: `$Id$`
-
+<!-- {{TOC}} -->
simpleSAMLphp news and documentation
------------------------------------
diff --git a/docs/simplesamlphp-modules.txt b/docs/simplesamlphp-modules.txt
index 94b1db58c..9aa6dc6a3 100644
--- a/docs/simplesamlphp-modules.txt
+++ b/docs/simplesamlphp-modules.txt
@@ -9,6 +9,7 @@ simpleSAMLphp modules
* Version: `$Id$`
+<!-- {{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-reference-idp-hosted.txt b/docs/simplesamlphp-reference-idp-hosted.txt
index 1e836342c..95c33daf7 100644
--- a/docs/simplesamlphp-reference-idp-hosted.txt
+++ b/docs/simplesamlphp-reference-idp-hosted.txt
@@ -1,6 +1,8 @@
IdP hosted metadata reference
=============================
+<!-- {{TOC}} -->
+
This is a reference for the metadata files
`metadata/saml20-idp-hosted.php` and `metadata/shib13-idp-hosted.php`.
Both files have the following format:
diff --git a/docs/simplesamlphp-reference-idp-remote.txt b/docs/simplesamlphp-reference-idp-remote.txt
index eff3183c2..96197ca62 100644
--- a/docs/simplesamlphp-reference-idp-remote.txt
+++ b/docs/simplesamlphp-reference-idp-remote.txt
@@ -1,6 +1,8 @@
IdP remote metadata reference
=============================
+<!-- {{TOC}} -->
+
This is a reference for metadata options available for `metadata/saml20-idp-remote.php` and `metadata/shib13-idp-remote.php`. Both files have the following format:
<?php
diff --git a/docs/simplesamlphp-reference-sp-hosted.txt b/docs/simplesamlphp-reference-sp-hosted.txt
index fd47918d0..668998f15 100644
--- a/docs/simplesamlphp-reference-sp-hosted.txt
+++ b/docs/simplesamlphp-reference-sp-hosted.txt
@@ -1,6 +1,8 @@
SP hosted metadata reference
============================
+<!-- {{TOC}} -->
+
This is a reference for the metadata files `metadata/saml20-sp-hosted.php` and `metadata/shib13-sp-hosted.php`. Both files have the following format:
<?php
diff --git a/docs/simplesamlphp-reference-sp-remote.txt b/docs/simplesamlphp-reference-sp-remote.txt
index 2f89ff913..c175b20d6 100644
--- a/docs/simplesamlphp-reference-sp-remote.txt
+++ b/docs/simplesamlphp-reference-sp-remote.txt
@@ -1,6 +1,8 @@
SP remote metadata reference
============================
+<!-- {{TOC}} -->
+
This is a reference for metadata options available for
`metadata/saml20-sp-remote.php` and `metadata/shib13-sp-remote.php`.
Both files have the following format:
diff --git a/docs/simplesamlphp-sp-api.txt b/docs/simplesamlphp-sp-api.txt
index fafc8d2ec..e94a3baeb 100644
--- a/docs/simplesamlphp-sp-api.txt
+++ b/docs/simplesamlphp-sp-api.txt
@@ -1,6 +1,8 @@
simpleSAMLphp SP API reference
==============================
+<!-- {{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-migration.txt b/docs/simplesamlphp-sp-migration.txt
index 28c6da922..564a4690a 100644
--- a/docs/simplesamlphp-sp-migration.txt
+++ b/docs/simplesamlphp-sp-migration.txt
@@ -1,6 +1,8 @@
Migrating to the `saml` module
==============================
+<!-- {{TOC}} -->
+
This document describes how you can migrate your code to use the `saml` module for authentication against SAML 2.0 and SAML 1.1 IdPs.
It assumes that you have previously set up a SP by using redirects to `saml2/sp/initSSO.php`.
diff --git a/docs/simplesamlphp-sp.txt b/docs/simplesamlphp-sp.txt
index 0ceaad005..1d8fcf307 100644
--- a/docs/simplesamlphp-sp.txt
+++ b/docs/simplesamlphp-sp.txt
@@ -9,6 +9,7 @@ SimpleSAMLphp Service Provider QuickStart
* Version: `$Id$`
+<!-- {{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](http://rnd.feide.no/content/installing-simplesamlphp).
diff --git a/docs/simplesamlphp-theming.txt b/docs/simplesamlphp-theming.txt
index a0fe59295..e287f298e 100644
--- a/docs/simplesamlphp-theming.txt
+++ b/docs/simplesamlphp-theming.txt
@@ -9,6 +9,7 @@ Theming the user interface in SimpleSAMLphp
* Version: `$Id$`
+<!-- {{TOC}} -->
In SimpleSAMLphp every part that needs to interact with the user by using a web page, uses templates to present the XHTML. SimpleSAMLphp comes with a default set of templates that presents a anonymous look.
diff --git a/docs/simplesamlphp-translation.txt b/docs/simplesamlphp-translation.txt
index f7e8d53d2..a77227d9c 100644
--- a/docs/simplesamlphp-translation.txt
+++ b/docs/simplesamlphp-translation.txt
@@ -9,6 +9,8 @@ SimpleSAMLphp Translation Portal
* Version: `$Id$`
+<!-- {{TOC}} -->
+
SimpleSAMLphp supports multiple languages.
* The SimpleSAMLphp Translation Portal
diff --git a/docs/simplesamlphp-ukaccess.txt b/docs/simplesamlphp-ukaccess.txt
index 23da452e9..73efc2925 100644
--- a/docs/simplesamlphp-ukaccess.txt
+++ b/docs/simplesamlphp-ukaccess.txt
@@ -9,6 +9,7 @@ Connecting SimpleSAMLphp SP to UK Access Federation and InCommon
* Version: `$Id$`
+<!-- {{TOC}} -->
This guide will describe how to configure simpleSAMLphp as a service provider (SP) supporting SAML 1.1 (shib1.3) and SAML 2.0 connecting it to a federation such as **UK Access Federation** or **InCommon**.
--
GitLab