Difference between revisions of "Template talk:CitePage"

Revision as of 23:25, 21 May 2009

This page is only a translation today and I may write like a child. If you find non sense I've just hidden the french text :-) Dominique Pautrel 23:25, 21 May 2009 (UTC)

Display

About graphical display. It is really basic today, thus easy to enhance...

How to paste values in a page ?

I started with entering this parameter in a heading, i.e. == Description ==, then the value in textbody. But when one's click on Edit, it was (obviously) the template !
Another use could be assigning categories.

Footer or Header ?

For my part, I'd think it more as a header, to resume essentials about the given document.

However, for not to take the whole page width, we could imagine that this template include itself on one side (left or right, one's can choose).

I wonder if it would be easy to add a <hide>/<show> button who could show additionnals informations of minor importance (a table test with a hide/show button) or if we could include a tab system. For this we need to observe how other sophisticated templates are built...

Synanceia (Pierre) 12:30, 19 May 2009 (UTC)

Top or Bottom ?: For my part I thinked there should not have frequently more data in the page, and so, when there is it need to be shown...
Right or Left ?: If one's want to put an "explorer" (to replace our old Template:Français), it will be right aligned. Thus, imho, not to the right... To tell a bit more... I don't know if it need to float on the left or (what I'd made alone for today), keep it in full width (default).; Dominique Pautrel 13:01, 20 May 2009 (UTC)

Choosing a method

One or more Templates ?

Old title : One template only with optionnal parameters

I don't think (Not as my firsts thoughts) that we need to build many templates. Only one could suffice, we just need to condition the display of a template row to the existence of the concerned parameter. Also, if the cited document as a "standard" status, one could hide this row to limit the numbers of information. (seem important to me if the template is a header !)
Synanceia (Pierre) 12:30, 19 May 2009 (UTC)

I wonder... In a manner a main template and some sub-templates could be easiest to understand, debug, maintain...

On the other way we'll probably need to deal with passing parameters.

I've asked for help or feedback (in english) : http://documentation.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=5459

And Clayton seem to find it could be a good idea, but as myself didn't saw nothing but a single link to a page, there is probably no template yet for doing such a thing. On my english page, he says he like the first one with an icon, and I agree with him it's look prettier.

Dominique Pautrel 17:38, 20 May 2009 (UTC)

Assigning Categories ?

If a template assign a category, changing the category in the template will change the category in all pages who use the template.
I see three possibles choices :

Pasting the value in the bottom of the page, as if the category had been entered by hand...
Build a robust "engine" to deal with them smartly.
Go with keywords. Not retained...

Exemple was an FR FAQ page about Writer. One's could assignate the four categories FR, Documentation, FAQ, and Writer. And use DPL queries to retrieve pages when intersecting many categories, which could be huges if asked alone. Existent structure is not like that (and perhaps it's better, I don't know).

Parameters

This template exist also in French. I'll try to keep the two versions up to date
What is following is nothing more than wished behavior... One could make a subsection for a parameter if necessary.
Please feel free to correct or add something. I've obviously missed a parameter.

Parameter	Values	Comments
Address	String	Don't forget http://... to make visible in the Help. (One's could dream with an info-balloon ...). We could also take the easiest method... no restriction and the user of the template put here document's type and weight.
Authors	String	Author(s) list. Recommend to split with a coma and a space.
Date	AAAA-MM-JJ	Last update of the document.
Description	String	It should be the largest string entered by the user. It can be built like a page, with headings, etc. But in that case the Edit links appears in the table cell and edit the template... hum, there's the magic word NOEDITSECTION but it don't seem smart to me.
Doc	Yes No	To distinguish if the Address parameter is a web page or a direct download link. Mandatory. (hu, I'd like so... at the first glance)
Legend	Yes No	If "Yes", then include the Title parameter as a DISPLAYTITLE command, thus only one instance per page, for How-Tos, Tutorials or Guides. "No" could permit to include more instances (FAQ) and assign "Main Entrance" with DISPLAYTITLE. ;-)
Module	Base Calc Draw General Impress Math Setup Writer	It would be nice (example with Base) that corresponding icon appears. ou carrément This parameter could also be used for defining a category to assign, but it's not sufficient for distinguish the document type, FAQ, How-To...
Platform	Linux Mac All (default) Windows etc. ?	State of the art could be that if absent, no exception is generated but string "All"
Status	Preliminary Standard Obsolete Other	While the document is not finalized. Stable. Out of Date or usable only with older versions. In this case, add comment. Thus authorize comments and use the three terms as [Balise] , at the beginning of the string.
Title	String	At this time it appears twice, for the page and for the table... It's also for this reason I imagined it as a footer... The fact of not including DISPLAYTITLE give the advantage to can put many instances of the template on one page (for FAQ type document]. Indeed one's need to create a switch parameter...

@@ Line 1: / Line 1: @@
+This page is only a translation today and I may write like a child. If you find non sense I've just hidden the french text :-) [[User:Dominique Pautrel|Dominique Pautrel]] 23:25, 21 May 2009 (UTC)
 == Display ==
-About graphical display
+About graphical display. It is really basic today, thus easy to enhance...
-Discussion sur l'aspect graphique de la page générée par ce modèle.
-Il est pour l'instant d'aspect archaïque, et donc d'autant plus facile à améliorer...
-=== Comment coller des valeurs dans la page ? ===
+=== How to paste values in a page ? ===
-* Au début j'avais entré <nowiki>== Description ==</nowiki> puis la valeur du paramètre en corps de texte. Mais il y avait un défaut, lorsqu'on cliquait sur ''Modifier'' la section, on éditait le modèle ! (logique, en même temps)
+* I started with entering this parameter in a heading, i.e. ''<nowiki>== Description ==</nowiki>'', then the value in textbody. But when one's click on ''Edit'', it was (obviously) the template !
-* Une autre utilité serait l'assignation de catégorie(s).
+* Another use could be assigning categories.
+=== Footer or Header ? ===
+For my part, I'd think it more as a header, to resume essentials about the given document. <br>
+<!--> Personnellement, je serai plutôt d'avis d'utiliser ce modèle en début de page, pour résumer les principales caractéristiques du document cité.<br> <-->
+However, for not to take the whole page width, we could imagine that this template include itself on one side (left or right, one's can choose). <br>
+<!--> Toutefois, pour ne pas prendre toute la largeur, nous pouvons imaginer que ce modèle s'incruste sur un des côtés (gauche ou droite, on peut choisir).<br> <-->
+I wonder if it would be easy to add a <hide>/<show> button who could show additionnals informations of minor importance ([[User:Synanceia_(Pierre)/Brouillons/Test1|a table test with a hide/show button]]) or if we could include a tab system. For this we need to observe how other sophisticated templates are built... <br>
+<!--> Je me demande s'il serait facile d'ajouter un bouton <cacher>/<masquer> qui pourrait dévoiler des informations supplémentaires jugées moins importantes ([[User:Synanceia_(Pierre)/Brouillons/Test1|un essai de tableaux avec un bouton <cacher>/<masquer>]]) ou si nous pouvons inclure un système d'onglets. Pour cela il me faut regarder comment sont construits d'autres modèles élaborés...<br> <-->
-=== Pied de page ou en-tête ? ===
-Personnellement, je serai plutôt d'avis d'utiliser ce modèle en début de page, pour résumer les principales caractéristiques du document cité.<br>
-Toutefois, pour ne pas prendre toute la largeur, nous pouvons imaginer que ce modèle s'incruste sur un des côtés (gauche ou droite, on peut choisir).<br>
-Je me demande s'il serait facile d'ajouter un bouton <cacher>/<masquer> qui pourrait dévoiler des informations supplémentaires jugées moins importantes ([[User:Synanceia_(Pierre)/Brouillons/Test1|un essai de tableaux avec un bouton <cacher>/<masquer>]]) ou si nous pouvons inclure un système d'onglets. Pour cela il me faut regarder comment sont construits d'autres modèles élaborés...<br>
 [[User:Synanceia (Pierre)|Synanceia (Pierre)]] 12:30, 19 May 2009 (UTC)<br>
-:;Haut ou bas ?
+:;Top or Bottom ?
-:: Pour ma part j'avais pensé qu'il n'y aurait pas forcément souvent un corps de page, et que donc ça mettrait ce dernier en valeur...
+:: For my part I thinked there should not have frequently more data in the page, and so, when there is it need to be shown...
-:;Droite ou gauche ?
+<!--> :: Pour ma part j'avais pensé qu'il n'y aurait pas forcément souvent un corps de page, et que donc ça mettrait ce dernier en valeur... <-->
-:: Si on voulait mettre un navigateur (à la place du modèle ''Français''), il serait à droite. Donc (amha) pas à droite... sinon je ne sais pas s'il faudrait le mettre à gauche ou (ce que j'aurais fait pour l'instant) le laisser pleine largeur (par défaut).
+:;Right or Left ?
+:: If one's want to put an "explorer" (to replace our old [[Template:Français]]), it will be right aligned. Thus, imho, not to the right... To tell a bit more... I don't know if it need to float on the left or (what I'd made alone for today), keep it in full width (default).
+<!--> :: Si on voulait mettre un navigateur (à la place du modèle ''Français''), il serait à droite. Donc (amha) pas à droite... sinon je ne sais pas s'il faudrait le mettre à gauche ou (ce que j'aurais fait pour l'instant) le laisser pleine largeur (par défaut). <-->
 :: [[User:Dominique Pautrel|Dominique Pautrel]] 13:01, 20 May 2009 (UTC)
-== Choix de méthode ==
+== Choosing a method ==
-=== Un ou plusieurs modèles ? ===
+=== One or more Templates ? ===
-: Ancien titre : Un seul modèle avec des paramètres optionnels <br>
+: Old title : One template only with optionnal parameters <br>
-Je ne pense pas (contrairement à mes premières idées) que nous devions élaborer plusieurs modèles. Un seul modèle peut suffire, il nous suffit de conditionner l'affichage d'une ligne du modèle à l'existence (ou non) du paramètre concerné. De même, si le document cité a pour statut "standard", on pourrait masquer cette ligne pour limiter le nombre d'information (cela me semble important si le modèle est placé en tête !<br>[[User:Synanceia (Pierre)|Synanceia (Pierre)]] 12:30, 19 May 2009 (UTC)
+I don't think (Not as my firsts thoughts) that we need to build many templates. Only one could suffice, we just need to condition the display of a template row to the existence of the concerned parameter. Also, if the cited document as a "standard" status, one could hide this row to limit the numbers of information. (seem important to me if the template is a header !) <br>
+<!--> : Ancien titre : Un seul modèle avec des paramètres optionnels <br>
+Je ne pense pas (contrairement à mes premières idées) que nous devions élaborer plusieurs modèles. Un seul modèle peut suffire, il nous suffit de conditionner l'affichage d'une ligne du modèle à l'existence (ou non) du paramètre concerné. De même, si le document cité a pour statut "standard", on pourrait masquer cette ligne pour limiter le nombre d'information (cela me semble important si le modèle est placé en tête !<br> <-->
+[[User:Synanceia (Pierre)|Synanceia (Pierre)]] 12:30, 19 May 2009 (UTC)
-:Je ne sais pas trop. D'un coté un modèle principal et plusieurs sous-modèles doivent être plus faciles à appréhender, déboguer, maintenir...
+: I wonder... In a manner a main template and some sub-templates could be easiest to understand, debug, maintain...
-:De l'autre cela fait des passages de paramètres à gérer.
+: On the other way we'll probably need to deal with passing parameters.
+<!-->:Je ne sais pas trop. D'un coté un modèle principal et plusieurs sous-modèles doivent être plus faciles à appréhender, déboguer, maintenir...
+:De l'autre cela fait des passages de paramètres à gérer.<-->
-:J'ai demandé de l'aide ou des retours (en anglais) : http://documentation.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=5459
+: I've asked for help or feedback (in english) : http://documentation.openoffice.org/servlets/ReadMsg?listName=dev&msgNo=5459
-:: Et Clayton semble trouver que ça peut être bon, mais n'a pas vu non plus autre chose qu'un lien simple vers une page, visiblement pas encore de modèle existant pour ce type de chose. Sur ma page anglaise, il aime bien le premier tableau avec l'icône, et je suis d'accord ça fait de suite plus sympa.
+:: And Clayton seem to find it could be a good idea, but as myself didn't saw nothing but a single link to a page, there is probably no template yet for doing such a thing. On [[User:Dominique_Pautrel/Wiki_Localization_Structure|my english page]], he says he like the first one with an icon, and I agree with him it's look prettier. <br>
+<!--> :: Et Clayton semble trouver que ça peut être bon, mais n'a pas vu non plus autre chose qu'un lien simple vers une page, visiblement pas encore de modèle existant pour ce type de chose. Sur ma page anglaise, il aime bien le premier tableau avec l'icône, et je suis d'accord ça fait de suite plus sympa. <-->
 : [[User:Dominique Pautrel|Dominique Pautrel]] 17:38, 20 May 2009 (UTC)
-=== Assignation de catégorie(s) ? ===
+=== Assigning Categories ? ===
-Si un modèle assigne une catégorie, la changer dans celui-ci la change dans toutes les pages qui utilisent le modèle. <br>
+If a template assign a category, changing the category in the template will change the category in all pages who use the template. <br>
+I see three possibles choices :
+# [[#How to paste values in a page ?|Pasting the value in the bottom of the page]], as if the category had been entered by hand...
+# Build a robust "engine" to deal with them smartly.
+# Go with keywords. Not retained...
+:: Exemple was an FR FAQ page about Writer. One's could assignate the four categories FR, Documentation, FAQ, and Writer. And use DPL queries to retrieve pages when intersecting many categories, which could be huges if asked alone. Existent structure is not like that (and perhaps it's better, I don't know). <br>
+<!-->Si un modèle assigne une catégorie, la changer dans celui-ci la change dans toutes les pages qui utilisent le modèle. <br>
 Je vois trois options possibles :
 # [[#Comment coller des valeurs dans la page ?|Figer la catégorie en bas de page]], comme si elle avait été entrée à la main...
 # Construire un "moteur" éprouvé pour les générer finement.
 # Procéder par mots-clés. Non retenu...
-:: L'exemple portait sur une page de FAQ FR pour Writer. Il aurait fallu assigner les quatre catégories FR, Documentation, FAQ, et Writer. Et user de requêtes pour retrouver les pages en intersectant plusieurs catégories, géantes si extraites seules. Ce n'est pas conçu (et c'est peut-être mieux) ainsi.
+:: L'exemple portait sur une page de FAQ FR pour Writer. Il aurait fallu assigner les quatre catégories FR, Documentation, FAQ, et Writer. Et user de requêtes pour retrouver les pages en intersectant plusieurs catégories, géantes si extraites seules. Ce n'est pas conçu (et c'est peut-être mieux) ainsi. <-->
+== Parameters ==
+This template exist also in French. I'll try to keep the two versions up to date <br>
+What is following is nothing more than wished behavior... One could make a subsection for a parameter if necessary. <br>
+Please feel free to correct or add something. I've obviously missed a parameter.
-== Paramètres ==
+<!--> Ce modèle existe également en anglais. Je vais tenter de maintenir les deux versions à jour <br>
-Ce modèle existe également en anglais. Je vais tenter de maintenir les deux versions à jour <br>
 Ce qui suit n'est pour l'instant que le comportement souhaité... chaque paramètre peut avoir sa sous-section si nécessaire. <br>
-N'ayez surtout pas peur de discuter ou d'ajouter quelque chose. J'ai forcément oublié un paramètre.
+N'ayez surtout pas peur de discuter ou d'ajouter quelque chose. J'ai forcément oublié un paramètre. <-->
 {| border=1 cellpadding=5
 |-
-! Paramètre !! Valeurs !! Commentaires
+! Parameter !! Values !! Comments
 |-
-|Adresse
+|Address
-|Chaîne de caractères
+|String
-|N'oubliez pas <nowiki>http://...</nowiki> à faire apparaître dans l'aide. (On peut rêver avec une infobulle...). Soit on ne s'embête pas avec la méthode la plus simple... aucune restriction et l'utilisateur du modèle renseigne ici le type de document et son poids
+|Don't forget <nowiki>http://...</nowiki> to make visible in the Help. (One's could dream with an info-balloon ...). We could also take the easiest method... no restriction and the user of the template put here document's type and weight.
 |-
-|Auteur
+|Authors
-|Chaîne de caractères
+|String
-|Liste des auteurs (Conseiller de séparer par une virgule et une espace)
+|Author(s) list. Recommend to split with a coma and a space.
 |-
 |Date
 |AAAA-MM-JJ
-|Date de dernière mise à jour du document.
+|Last update of the document.
 |-
 |Description
-|Chaîne de caractères
+|String
-|Normalement la plus grande chaîne entrée par l'utilisateur. À noter que l'on peut la construire comme une page, avec titres et tout. Mais dans ce cas les liens ''Modifier'' apparaissent dans la cellule du tableau et modifient le modèle... bon il y a bien [http://meta.wikimedia.org/wiki/Aide:Mots_magiques#__NOEDITSECTION__ ce mot magique] (amusant, l'effet secondaire de ce lien NOEDITSECTION) mais... ça ne me parait pas élégant.
+|It should be the largest string entered by the user. It can be built like a page, with headings, etc. But in that case the ''Edit'' links appears in the table cell and edit the template... hum, there's the magic word NOEDITSECTION but it don't seem smart to me.
 |-
 |Doc
 |
-# Oui
+# Yes
-# Non
+# No
 |
-# Pour distinguer si le paramètre ''Adresse'' est une page Web ou un lien de téléchargement direct.
+# To distinguish if the ''Address'' parameter is a web page or a direct download link.
-# Obligatoire. (enfin, c'est ce que j'aimerais... à priori)
+# Mandatory. (hu, I'd like so... at the first glance)
 |-
-|Légende
+|Legend
 |
-# Oui
+# Yes
-#Non
+# No
-| Réglé sur Oui, inclus le titre dans DISPLAYTITLE, donc un seul modèle par page, pour un How-To, Guide ou autre Tutoriel. Non permet d'en inclure plusieurs instances et de marquer "Entrée principale" ;-) sur le DISPLAYTITLE de la page.
+| If "Yes", then include the Title parameter as a DISPLAYTITLE command, thus only one instance per page, for How-Tos, Tutorials or Guides. "No" could permit to include more instances (FAQ) and assign "Main Entrance" with DISPLAYTITLE. ;-)
 |-
 |Module
@@ Line 85: / Line 109: @@
 # Calc
 # Draw
-# Général
+# General
 # Impress
-# Installation
 # Math
+# Setup
 # Writer
-|Il faudrait (exemple avec Base) que l'icône correspondante s'affiche. [[Image:Base.png|50px]] ou carrément [[Image:Base.png]] <br>
+|It would be nice (example with Base) that corresponding icon appears. [[Image:Base.png|50px]] ou carrément [[Image:Base.png]] <br>
-Ce paramètre peut-être également utilisé pour définir la catégorie à assigner, mais il ne suffit pas seul à distinguer une astuce de type FAQ à une procédure complète type How-To...
+This parameter could also be used for defining a category to assign, but it's not sufficient for distinguish the document type, FAQ, How-To...
 |-
-|Plate-forme
+|Platform
 |
 # Linux
 # Mac
-# Toutes (défaut)
+# All (default)
 # Windows
 # etc. ?
-|Le fin du fin serait que si ce paramètre n'est pas renseigné, au lieu d'une erreur il affiche "Toutes"
+|State of the art could be that if absent, no exception is generated but string "All"
 |-
-|Statut
+|Status
 |
-# Préliminaire
+# Preliminary
 # Standard
-# Obsolète
+# Obsolete
-Autres
+Other
 |
-# Tant qu'il n'est pas finalisé.
+# While the document is not finalized.
 # Stable.
-# Plus à jour où uniquement utilisable avec d'anciennes versions. Dans ce cas, préciser.
+# Out of Date or usable only with older versions. In this case, add comment.
-Donc autoriser les commentaires et se servir de ces trois termes comme balise d'en-tête de la chaîne.
+Thus authorize comments and use the three terms as [Balise] , at the beginning of the string.
 |-
-|Titre
+|Title
-|Chaîne de caractères
+|String
-|Pour l'instant il apparaît deux fois, pour la page et pour le tableau... c'est également pour cette raison que j'avais imaginé l'option Pied de page... <br>
+|At this time it appears twice, for the page and for the table... It's also for this reason I imagined it as a footer... <br>
-Le fait de ne pas inclure DISPLAYTITLE apporterait l'avantage qu'on pourrait mettre plusieurs fois le modèle sur une page (pour des documents de type FAQ). En fait il faudrait créer un paramètre interrupteur...
+The fact of not including DISPLAYTITLE give the advantage to can put many instances of the template on one page (for FAQ type document]. Indeed one's need to create a switch parameter...
 |-
 |}

Difference between revisions of "Template talk:CitePage"

Revision as of 23:25, 21 May 2009

Contents

Display

How to paste values in a page ?

Footer or Header ?

Choosing a method

One or more Templates ?

Assigning Categories ?

Parameters

Views

Personal tools

Navigation

Search

Tools