diff --git a/docs/source/simplesamlphp-advancedfeatures.xml b/docs/source/simplesamlphp-advancedfeatures.xml index 8c7755ec92a4f7b38eddf73c38ea2fbcde6ef128..0dfa4514a2b7cacc6ae51f83c24f425ab44ab8a1 100644 --- a/docs/source/simplesamlphp-advancedfeatures.xml +++ b/docs/source/simplesamlphp-advancedfeatures.xml @@ -4,6 +4,24 @@ <article> <title>simpleSAMLphp advanced features</title> + <section> + <title>simpleSAMLphp documentation</title> + + <para>This document is part of the simpleSAMLphp documentation + suite.</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://rnd.feide.no/view/simplesamlphpdocs">List of + all simpleSAMLphp documentation</ulink></para> + </listitem> + </itemizedlist> + + <para>This document assumes that you already have a installation of + simpleSAMLphp running, configured and working. This is the next step + :)</para> + </section> + <section> <title>Bridging between protocols</title> @@ -196,7 +214,7 @@ $attributemap = array( </section> <section> - <title>Automated testing </title> + <title>Automated testing</title> <para>simpleSAMLphp includes a test script that can go to a simpleSAMLphp SP, initiate login, enter some credentials, and then follow the response diff --git a/docs/source/simplesamlphp-idp.xml b/docs/source/simplesamlphp-idp.xml index f7e3d0e991e081c6f01b14f01fc4a178d783fbe3..c4fb6977b72b10e0226fd3f222a1c089efb85457 100644 --- a/docs/source/simplesamlphp-idp.xml +++ b/docs/source/simplesamlphp-idp.xml @@ -18,6 +18,24 @@ </author> </articleinfo> + <section> + <title>simpleSAMLphp documentation</title> + + <para>This document is part of the simpleSAMLphp documentation + suite.</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://rnd.feide.no/view/simplesamlphpdocs">List of + all simpleSAMLphp documentation</ulink></para> + </listitem> + </itemizedlist> + + <para>This document assumes that you already have a installation of + simpleSAMLphp. Before you continue make sure all the required entries in + the check list at the buttom is showing green light.</para> + </section> + <section> <title>Enabling the Identity Provider functionality</title> diff --git a/docs/source/simplesamlphp-install.xml b/docs/source/simplesamlphp-install.xml index 2866b497715c2fe26e3d7403d475dfb5a31231a4..bcd037cf72f05f0d28c7d0051d969df1543f2969 100644 --- a/docs/source/simplesamlphp-install.xml +++ b/docs/source/simplesamlphp-install.xml @@ -18,28 +18,53 @@ </author> </articleinfo> + <section> + <title>simpleSAMLphp documentation</title> + + <para>This document is part of the + <application>simpleSAMLphp</application> documentation suite.</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://rnd.feide.no/view/simplesamlphpdocs">List of + all simpleSAMLphp documentation</ulink></para> + </listitem> + </itemizedlist> + </section> + <section> <title>News about simpleSAMLphp</title> - <para>To get the latest news about simpleSAMLphp you can follow this url: - <ulink + <para>To get the latest news about + <application>simpleSAMLphp</application> you can follow this url: <ulink url="http://rnd.feide.no/taxonomy/term/4">http://rnd.feide.no/taxonomy/term/4</ulink>. It also conatins an RSS feed.</para> - <para>Here is the simpleSAMLphp homepage: <ulink + <para>Here is the <application>simpleSAMLphp</application> homepage: + <ulink url="http://rnd.feide.no/simplesamlphp">http://rnd.feide.no/simplesamlphp</ulink></para> </section> <section> <title>Prerequisites</title> - <para>PHP version >= 5.1.2. If you want to run the Shibboleth 1.3 part - of simpleSAMLphp, you must have PHP >= 5.2.</para> + <itemizedlist> + <listitem> + <para><application>PHP</application> version >= 5.1.2. If you want + to run the <emphasis>Shibboleth 1.3 SP</emphasis> part of + <application>simpleSAMLphp</application>, you must have + <application>PHP</application> >= 5.2.</para> + </listitem> - <para>Apache or some other webserver.</para> + <listitem> + <para><application>Apache </application>or some other webserver. + </para> + </listitem> + </itemizedlist> - <para>simpleSAMLphp is mostly tested on different Linux, Unix, and Mac OS - X, but someone has also made it work on Windows.</para> + <para><application>simpleSAMLphp</application> is mostly tested on + different Linux, Unix, and Mac OS X, but someone has also made it work on + Windows.</para> </section> <section> diff --git a/docs/source/simplesamlphp-maintenance.xml b/docs/source/simplesamlphp-maintenance.xml index 359a1411d97faa20658045350d351bfb8a2cea6b..98cf516235ad897e7c51533a0b332b58e8629e1d 100644 --- a/docs/source/simplesamlphp-maintenance.xml +++ b/docs/source/simplesamlphp-maintenance.xml @@ -22,6 +22,24 @@ <para>This document is in progress of beeing written.</para> </warning> + <section> + <title>simpleSAMLphp documentation</title> + + <para>This document is part of the simpleSAMLphp documentation + suite.</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://rnd.feide.no/view/simplesamlphpdocs">List of + all simpleSAMLphp documentation</ulink></para> + </listitem> + </itemizedlist> + + <para>This document assumes that you already have a installation of + simpleSAMLphp running, configured and working. This is the next step + :)</para> + </section> + <section> <title>Session management</title> @@ -162,7 +180,7 @@ the session being deleted from the memcache servers while it is still in use.</para> - <para>Set this value to 0 if you don't want data to expire. </para> + <para>Set this value to 0 if you don't want data to expire.</para> <note> <para>The oldest data will always be deleted if the memcache server @@ -272,36 +290,82 @@ <section> <title>Multi-language support</title> - <para>Localization files in <filename>dictionaries/</filename>. In - addition some text is stored in the XHTML templates, so you may copy the - <filename>en</filename> directory to in example <filename>no</filename> - directory to do a norwegian translation.</para> + <para>Localization files in <filename>dictionaries/</filename>.</para> + + <para>To add support for a new language add your new language to the + language.available configuration parameter in + <filename>config.php</filename>:</para> + + <programlisting> /* + * Languages available and what language is default + */ + 'language.available' => array('en', 'no', 'dk', 'es', 'xx'), + 'language.default' => 'en',</programlisting> + + <para>Please use the standarized <ulink + url="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">language codes + as specified in ISO-639-1</ulink>.</para> + + <para>You also can set the default language. What is really important is + that the default language is complete! The default language is also the + fallback, so that when a user selects a language that in example has not + translated all the error messages, then strings from the default languae + is used instead.</para> + + <tip> + <para>This may change in the future. We may distinguish between the + fallback-lanauge (which usually are english) and the default + language.</para> + </tip> + + <para>Next, the translation it self needs to be done. All the strings can + be localized by editing the files in <filename>dictionaries/</filename>. + Add a new entry for each string, with your language code, like + this:</para> + + <programlisting>'user_pass_header' => array( + 'en' => 'Enter your username and password', + 'no' => 'Skriv inn brukernavn og passord', + 'xx' => 'Pooa jujjique jamba', +),</programlisting> + + <para>You can translate as much as you would like, a full translation is + not required. Though, it looks abit stupid with half of the text in + english, and only half of the text localized.</para> </section> <section> - <title>Customizing the web frontend</title> - - <para>All XHTML templates are stored in the simplesamlphp/templates - directory. They are stored in a two level hierarchy; first the theme name, - and then the language code.</para> - - <example> - <title>Example of organization of themes</title> - - <para>An example of a directory structure:</para> - - <literallayout>templates/default/en -templates/default/no -templates/dkaaitheme/en -templates/dkaaitheme/dk -</literallayout> - </example> - - <para>Which theme to use is specified in the - <filename>config.php</filename> file, where the metadata dir is specified. - To use the dkaaitheme as illustrated in the above example, set the value - of <literal>templatedir</literal> to - <filename>templates/dkaaitheme/</filename>.</para> + <title>Customizing the web frontend with themes</title> + + <para>All XHTML templates are stored in the + <filename>templates/</filename> directory. In this directory there is one + directory for each theme. The default theme is named + <literal>default</literal>. An example theme is provided named + <literal>feidernd</literal>.</para> + + <para>It is possible to define a new theme, where only some of the pages + is customized, for the rest of the pages, the default theme can be used. + The feidernd theme is a good example of this, here only the login page is + customized.</para> + + <para>In <filename>config.php</filename> you specify which theme that you + would like to use, as well as a theme base. The theme base is the fallback + theme that should be used when the selected theme does not include the + specific template needed to render a page. Here is an example of a + configuration:</para> + + <programlisting> /* + * Which theme directory should be used? The base is fallback (leave it to default). + */ + 'theme.use' => 'feidernd', + 'theme.base' => 'default',</programlisting> + + <important> + <para>The feidernd theme is based on the wordpress login form style. + Feel free to use this as a base for making your own login form. But + please do not use the feidernd theme as it is, because it contains the + Feide logo, which off course should not be used outside Feide.</para> + </important> </section> <section> diff --git a/docs/source/simplesamlphp-sp.xml b/docs/source/simplesamlphp-sp.xml index 4b7821f055c4ad6cf5621aeae40cdea9b34024f4..3ada4313d4af53fbf669ee1074274ed258b118dd 100644 --- a/docs/source/simplesamlphp-sp.xml +++ b/docs/source/simplesamlphp-sp.xml @@ -24,6 +24,24 @@ released in March 2008.</para> </note> + <section> + <title>simpleSAMLphp documentation</title> + + <para>This document is part of the simpleSAMLphp documentation + suite.</para> + + <itemizedlist> + <listitem> + <para><ulink url="http://rnd.feide.no/view/simplesamlphpdocs">List of + all simpleSAMLphp documentation</ulink></para> + </listitem> + </itemizedlist> + + <para>This document assumes that you already have a installation of + simpleSAMLphp. Before you continue make sure all the required entries in + the check list at the buttom is showing green light.</para> + </section> + <section> <title>Introduction</title>