Authentic — Administrator Guide : Advanced Settings : 俺約

 

Advanced Settings (アドバンス設定)

Advanced Settings allows you to fully customise Authentic public pages, playing with these paramaters, in this order (it matters): themes, templates, public pages.

Theme customisation(テーマのカスタマイズ)

The theme rules the general style of public pages. Some themes are available and defines (using Cascading Style Sheets) the basic elements of public pages display. You can define your own theme (with your own banner and logo…) if you are familiar enough with CSS.

A theme provides at least two files: desc.xml and authentic.css. desc.xml is an XML file containing some basic informations about the theme: its name and version, its label, its description and its author. For instance :

 <?xml version="1.0"?>
   <theme name="Fake" version="1.0">
     <label>Fake</label>
     <desc>Fake Theme used to explain</desc>
     <author>Frederic Peters</author>
    </theme>

The style sheet defines the different properties applied to each pages elements. Those two files must be put in the same directory under /usr/share/authentic/themes/. Once the directory and the two files are created the theme becomes available in the administration interface, you can use it. You can as well put an image called icon.jpg, size 30×30, which will illustrate the theme in the selection page.

Template Customisation(テンプレートカスタマイズ)

If you customisation needs are beyond what can be done using CSS, you should then think about adding in the theme directory a file called template.ezt. The template defines the structure of all the public pages within a particular theme. It means, apart from the themes, it is possible yet to modify the display of all public pages, modifying the template. Templates are simple text files which contain (among others) some variables, written between square brakets. These variables are substituted in the public page by their values. Here are the variables you should know (among others) to modify the template:

  • page_title: the page title displayed in the title bar if it is correctly set in a <title> tag;

  • css: the style sheet file name, including path;

  • script: javascripts used by Authentic fore some features like sorting lists;

  • onload: javascript instructions associated to an event. This variable should be set as the value of the <body> tag onload attribute;

  • body_class: this variable should be used as the value of the <body> tag class attribute. This value is used by the style sheet;

  • title: the page title, displayed on top of it;

  • site_name: the organisation name you enterered when creating the identity provider;

  • prelude: empty variable at the moment;

  • breadcrumb: the breadcrumb;

  • body: main content of the page, usually set between the title and the footer;

you can test a variable is not empty with this syntax: [if-any variable-name]...[end]

Public pages customisation (パブリックページカスタマイズ)

To go a step further in customisation, you can define for each public page some variations within the selected theme and template. As for the template, you can use some variables written between square brakets.

Account Management(アカウント管理)

This page is displayed to the user immediatly after his/her identification. The variables available for this page are:

  • identity_label (the user name) ;

  • idp_sso_list (List of the Service Providers the users can connect to) ;

  • federations_list (active federations list).

Registration(登録)

This page is displayed to the user when he/she creates his/her identity. Only one variable available for this page:

  • register_form (the form filled to create the identity).

Registration Completed(登録完了)

This page is displayed to the user when he/she has validated his/her registration. No variables available.

Changing Password(パスワード変更)

This page is displayed to the user when he/she wants to modify his/her password. Only one variable available for this page:

  • change_password_form (the form filled to change password) ;

Login(ログイン)

This page is the page on which the users must enter his/her username and password. The variables available for this page:

  • login_form (the form allowing to type the username and the password);

  • authentication_failure (the message indicating authentication failure).

Lost Password(パスワード忘れ)

This page is displayed to the user when he/she tries to retrieve his/her password. The variables available for this page:

  • lost_password_form (the form used to type the username);

  • behaviour: this variable is not displayed but contains the kind of behaviour adopted in case of password loss (nothing, emailed password, question asked). this variable must be used with this kind of conditions:

    • [is behaviour "email_reminder"] You will receive an email [end];

    • [is behaviour "dumb_question"] You will be asked a question [end].

Lost Password Question(パスワード忘れ質問)

This page is displayed to the user when he/she tries to retrieve his/her password and he/she has to answer a question to do so. Only one variable available for this page:

  • lost_password_question_form (the form asking the question and recording the answer).

Lost Password (mailed)(パスワード忘れ・メール送信)

This page is displayed to the user when he/she tries to retrieve his/her password and it has been sent by email. No variables available.

Updating Personal Information(個人情報更新)

This page is displayed to the user when he/she updates his/her identity datas. Only one variable available for this page:

  • info_form (the form displaying user datas and recording modifications).

Licenses

Authentic, Candle and Lasso are released under the terms of the GNU General Public License.

Authentic — Administrator Guide

カテゴリー: 未分類 パーマリンク

コメントを残す

以下に詳細を記入するか、アイコンをクリックしてログインしてください。

WordPress.com ロゴ

WordPress.com アカウントを使ってコメントしています。 ログアウト / 変更 )

Twitter 画像

Twitter アカウントを使ってコメントしています。 ログアウト / 変更 )

Facebook の写真

Facebook アカウントを使ってコメントしています。 ログアウト / 変更 )

Google+ フォト

Google+ アカウントを使ってコメントしています。 ログアウト / 変更 )

%s と連携中