Outils pour utilisateurs

Outils du site


public:specs_doc_corpus

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
public:specs_doc_corpus [2014/02/14 16:05]
matthieu.decorde@ens-lyon.fr
public:specs_doc_corpus [2014/09/08 10:53] (Version actuelle)
alexei.lavrentev@ens-lyon.fr
Ligne 3: Ligne 3:
 ===== Objectif ===== ===== Objectif =====
  
-Améliorer les capacités éditoriales de documentation ​de corpus ​+Améliorer les capacités éditoriales de documentation ​d'​édition). 
-  * Accueil + 
-  Description +3 fonctionnalités se dégagent ​
-  Introduction +  ​* Fonctionalités CMS du portail 
-  Contact +    ​* Accueil, Aide, Contact du portail (pages actuelles) 
-  Aide+    Documentation paratextuelle de corpus 
 +      Accueil 
 +      ... 
 +    Documentation paratextuelle d'​édition 
 +      * Sommaire général de l'​édition (accueil, texte de l'​édition,​ glossaire, indexes, ...) 
 +      * Accueil 
 +        * Sommaire de l'​accueil
  
 ==== Version portail ==== ==== Version portail ====
  
-Pouvoir afficher un jeu de pages associées à un corpus.+  * Tickets associés 
 +    * [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​443|443 : GWT: x,x, Reconsider the architecture of HTML pages]] 
 +    * [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​597|597 : GWT: x.x, Edition, display outline for text or introduction]] 
 +    * [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​724|724 : GWT: x.x, Add Documentation command to contextual menu]] 
 +    * [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​726|726 : DOC: do the admin & dev documentation for the new features]] 
 +    * [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​1002|1002 : GWT: x.x, Display corpus name in the "​Documentation"​ tab label]]
  
-Gestion ​de la langue : comme les fichiers properties de I18n. Pas de suffix = langue par défaut du portail.+Mettre en place une arborescence ​de pages.
  
-Commande "​Afficher page", arguments : +Gestion ​de la langue ​comme les fichiers properties ​de I18n. Pas de suffixe = langue ​par défaut du portail.
-  * Chemin ​de corpus ​"/"​ pages racine du portail +
-  * nom de page +
-  * profil (option) +
-  * langue ​(option)+
  
-  ​Ordre de fetch : +=== Nouvelles commandes === 
-    * / +  ​Commande "​Page"​ 
-      * NOM +    * arguments : 
-      * NOM_de +      * path : chemin dans l'​arborescence des pages : "/​sous-dossier/page" 
-      * NOM_PROFIL +      * profil (option) 
-      * NOM_PROFIL_de +      * langue (option) (= paramètre "​locale"​ ?) 
-    * /BFM2014 +    * Peut se déclencher par l'​entrée du portail avec le arguments 
-      * NOM +      * cmd=page 
-      * NOM_de +      * path=chemin de la page 
-      * NOM_PROFIL +  * Commande "​Documentation"​ 
-      * NOM_PROFIL_de+    * Appeler depuis un corpus sélectionné 
 +      * Appelle en interne la commande "​page"​ avec le chemin : "/CORPUS/​documentation"​ 
 +    * arguments URL : 
 +      * path : Chemin vers le corpus (ex: /GRAAL) 
 +      * profil (option) 
 +      * langue (option) (= paramètre "​locale"​ ?) 
 + 
 +<​note><​nowiki>​l'​URL http://​....?​cmd=page&​path=/​GRAAL/​Documentation est équivalent à l'URL http://​....?​cmd=documentation&​path=/​GRAAL</​nowiki></​note>​ 
 + 
 +<​note>​The documentation tab label must contain the name of the corpus</​note>​ 
 + 
 +=== Organisation des pages === 
 +  * Elles sont stockées dans la partie privée du site (même contraintes que les pages d'​édition qui peuvent être limitées en accès) 
 +  * Résolution d'une page qui s'​appelle "​NOM"​ dans le sous-dossier "​NIVEAU"​ 
 +    * le répertoire qui contient la page est "/​DOSSIER"​. "/"​ la racine site. 
 +    * Ordre de résolution du fichier HTML en fonction du profil "​profil"​ de l'​utilisateur et de la langue "​lang"​ du portail (remarque un profile ne peut pas avoir le nom qu'une langue). 
 +      - NOM_PROFIL_lang 
 +      - NOM_PROFIL 
 +      ​- NOM_lang 
 +      - NOM 
 +<​note>​Le profil est prioritaire sur la langue car il change le message de la page contrairement à la langue</​note>​ 
 + 
 +  * Navigation dans les pages : 
 +    * Gestion de chemin de fer 
 +    * Si possible : Gestion d'​historique du navigateur (note pour matt : avec les #) 
 +    * Gestion d'​hyperlien :  
 +      * interne 
 +        * = change le chemin de fer 
 +        * relative ou absolue 
 +      * externe 
 +        * ouvre un onglet du navigateur 
 +       
 +=== Quid === 
 +  * de la page d'​accueil,​ contact et aide : rentre ds la logique de CMS ? 
 +  ​des notices
  
 Ajouter des specs : scénarisation de l'UI générale du portail TXM (mode édition, mode multi-corpus,​ mode mono-corpus,​ ...) Ajouter des specs : scénarisation de l'UI générale du portail TXM (mode édition, mode multi-corpus,​ mode mono-corpus,​ ...)
Ligne 38: Ligne 79:
 ===== Méthode ===== ===== Méthode =====
  
 +  * 1ere étape : plusieurs pages HTML, navigation page vers page , cas particulier où **corpus=edition** 
 +    * Implémenter l'​accès à une page CMS :  
 +      * par commande "​Page"​  
 +        * paramètre : chemin vers la page à afficher (ex: /​Dossier/​Page ; /Home ; /GRAAL/Home ) 
 +        * Les pages sont stockées dans la zone public (webapps) 
 +        * Focus sur la page si déjà ouverte sinon ouvre un onglet. 
 +      * par URL d'​accès direct à une page CMS = commande '​Page'​ 
 +        * Lance le portail 
 +      * par commande '​Documentation'​ (de corpus) 
 +        * se lance sur un Corpus 
 +        * icone '​maison'​ 
 +        * L'​accès direct par URL appelle en interne la commande '​Page'​ avec un chemin reconstruit et un titre 
 +    * Implémenter les hyperliens internes : reproduire le mécanisme de la version GRAILS "page -> page"​ 
 +      * Ne lance pas le portail 
 +  * 2e étape : Layout 
 +    * Le label de l'​onglet Documentation contient le nom du corpus, cf. le ticket [[https://​forge.cbp.ens-lyon.fr/​redmine/​issues/​1002|#​1002]] 
 +    * Le chemin de fer : affiche la hiérarchie de la page 
 +      * on peut cliquer dans le chemin pour remonter dans la hiérarchie 
 +    * Sommaire CMS 
 +      * généré à la main, c'est une page CMS 
 +      * implémenter des layouts : reproduire le mécanisme de la version GRAILS sommaire -> page 
 +        * ajouter une option pour définir le target d'un hyperlien interne. Par exemple, "​south"​ ouvre la page dans la partie basse de la page courante (split vertical), "​north"​ dans la partie haute, "​center"​ ...). [Commentaire (SH) : ce serait bien d'​imiter (et se limiter à) un mécanisme existant déjà pour profiter de sa documentation,​ expérience,​ etc.] Est-ce-qu'​une page ouverte dans zone remplace l'​ancienne page si la zone est déjà ouverte ? 
 +  * 3e étape : Atomisation nucléaire 
 +    * Retirer l'​onglet "​Accueil"​ par défaut 
 +    * Ajouter un nouveau paramètre de portail pour afficher la page d'​accueil si il n'y a pas de paramètre d'URL "​command=Page"​ 
 +    * Pour afficher la page d'​accueil à l'​arrivée,​ on rajoute les paramètres d'URL : "​command=Page&​path=/​Home"​ 
 +    * Ajouter un bouton "​Accueil"​ en haut à droite : ouvre la page /Home 
 +    * Icone du portail dans la toolbar : ouvre la page /Home 
 +  * 4e étape : intégration des pages HTML notices, informations de corpus... 
 +  * ...
  
 ==== État de la plateforme ==== ==== État de la plateforme ====
Ligne 49: Ligne 119:
 ===== Recette ===== ===== Recette =====
 ==== Protocole de test ==== ==== Protocole de test ====
-=== Alpha === +=== Étape 1 === 
-=== Beta ===+  * Afficher l'​accueil de l'​édition 
 +  * Afficher l'​introduction de l'​édition 
 +  * sommaire de l'​introduction 
 +  * sommaire de l'​édition 
 ==== État courant ==== ==== État courant ====
 Qui Quand Quoi Qui Quand Quoi
  
public/specs_doc_corpus.1392390314.txt.gz · Dernière modification: 2014/02/14 16:05 par matthieu.decorde@ens-lyon.fr