Freedom propose des mécanismes d'aide en ligne. Ils permettent, depuis les interfaces standards des documents, de proposer à l'utilisateur un accès direct à une documentation d'aide. Les mécanismes d'aide en ligne prennent en compte la langue choisie par l'utilisateur lors de sa connexion. Les documents d'aide en ligne sont stockés dans freedom et par conséquent sont modifiables directement depuis les interfaces WEB freedom par les personnes habilitées.

L'aide en ligne est découpée en pages HTML. Les pages contiennent des rubriques.
Une page est un document de la famille HELPPAGE. Chacune des rubriques est une zone de texte formatée (htmltext).
Il est possible d'accéder à une page d'aide ou à une rubrique précise de la page d'aide.

Lors de la création/modification d'une page d'aide, il est possible d'ajouter des rubriques. La rubrique est référencée par un identifiant unique dans la page. Pour chacune des rubriques la liste des traduction est affichée et un bouton permet d'ajouter une traduction. La locale est désignée par l'utilisateur parmi les locales de traduction ¹⁾ (paramètre de la famille HELPPAGE).

Si la page d'aide est liée à une famille, lors de l'ajout d'une rubrique la liste des attributs est proposée en plus. Il est donc possible de créer une rubrique par attribut. Il est alors possible de décrire une aide sur un onglet, un cadre ou un attribut précis.

L'aide en ligne est composée de documents contenant des rubriques. Les documents sont accessibles par leur noms logiques. La rubrique est accessible (ancre HTML) : le document est affiché et positionné sur la rubrique référencée. Chaque rubrique est traduite individuellement.

Dans une page d'aide il est possible de référencer une autre page d'aide en utilisant la syntaxe [HELP nlogique#rubrique]. Ces références sont des liens en consultation.

Une page d'aide est accessible par une action freedom HELPPAGE ayant un paramètre obligatoire : le nom logique du document page d'aide, deux attributs optionnels :

• l'identifiant de la rubrique.
• la locale (langue) de la rubrique (par défaut celle de l'utilisateur connecté).

Pour les familles ayant une page d'aide, un item aide est ajouté aux menus des documents. En édition, un accès à l'aide est proposée au niveau de chacun des attributs si la rubrique correspondante possède au moins une traduction. Cet accès affiche la page demandée en entier est et positionné sur la rubrique dans une fenêtre d'aide (freedom interface 2.x : fenêtre du navigateur, 3.x fenêtre extjs).

Si la traduction dans la langue courante de l'utilisateur n'existe pas pour certaines rubriques, l'utilisateur pourra voir les autres traductions possibles.

Dans les spécifications de familles (ODS) 2 mécanismes sont implémentés :

• dans la déclaration de la famille, la propriété HELP permet de demander l'association à une page d'aide pour les documents de la famille (syntaxe : HELP nom_logique_de_la_page)
• une option sur les attributs permet de référencer une aide en édition : help=nom_logique#rubrique

En consultation, la page d'aide est composée de 2 colonnes :

• à gauche la liste des rubriques
• à droite le contenu de l'aide

L'édition des pages d'aide est contrôlé par profil freedom.