tvExplorer : infos et fonctionnement

Salut à tous,

En attendant la sortie de ditto 2.0
Voici quelques informations sur tvExplorer.
Je diffuserai le code une fois que ditto sera disponible


tvExplorer
demo en ligne
sample 1=> http://www.dixsix.fr/explorer/
sample 2=>http://www.dixsix.fr/explorer/index.php?id=406

A quoi ça sert:
tvExplorer est une extension du module tvEditor. infos ici => http://modxcms.com/forums/index.php/topic,9812.0.html
tvExplorer permet de restituer sur le front les Tvs et (la valeur de leurs options) selon leur type dans un formulaire de recherche.
La liste des résultats est obtenue via ditto.
L’ensemble des filtres représentant les critères de recherche sont générés automatiquement par tvExplorer.

Seules les tv de type:
-text
-checkbox
-option
-listbox-multiple
-listbox-single
-listbox
-dropdown
sont prises en compte.


Les Parametres de tvExplorer:

Output html du formulaire

L’ensemble du code html du formulaire est réalisé à partir de chunks.
La création du formulaire repose entièrement sur la class makeForm de Jason (openGeek)

&formTpl: le chunk du formulaire
Il contient obligatoirement les placeholders suivants
[+action+] => url ou id
[+name+]=> nom du formulaire
[+method+]=> methode d’envoi du formulaire
[+tvEditorForm+] => Sera remplacé par les éléments constituant le formulaire.

Ex:

<form action="[+action+]" name="[+name+]" id="[+name+]" method="[+method+]">
[+tvEditorForm+]
</form>

Pour restituer les éléments on va utiliser quasi systématiquement deux chunks:
- un pour envelopper la série d’élements
- et un pour rendre chacun des éléments.

Ex: Une série de checkbox
L’élement enveloppant est &listCheckTpl, il contient un placeholder([+listCheckbox+]) qui sera remplacé par les options de la TV

&listCheckTpl:

<fieldset>
[+listCheckbox+]
</fieldset>

Chaque checkbox sera restituée en utilisant &listCheckItemTpl
&listCheckItemTpl:

<label class="checkbox" [+for+]>
<input class="checkbox" type="[+type+]" [+id+] name="[+name+]" [+value+][+size+][+checked+][+disabled+][+style+][+events+]/>[+label+]
</label>
[+extra+]

Ex: une série de radio
L’élement enveloppant est &listRadioTpl, il contient un placeholder([+listRadioItem+]) qui sera remplacé par les options de la TV sous la forme d’input type radio

&listRadioTpl:

<fieldset>
[+listRadioItem+]
</fieldset>

&listRadioItemTpl:

<label class="radio[+required+][+optional+]" for="[+name+]">
<input class="radio" type="[+type+]" id="[+name+]" name="[+name+]" [+value+][+size+][+checked+][+disabled+][+style+][+events+]/>[+label+]
</label>[+extra+]

etc ...

En résumé les parametres pour gérer l’output du formulaire sont

&formTpl = chunk général du formulaire

- Tv de type text
&mitTpl = chunk enveloppant les éléments de type="text"
&inputTextTpl = chunk restitutant les éléments de type="text"
- Tv de type dropdwon, listbox
&selectTpl = chunk enveloppant les éléments de type="select"
&optionTpl = chunk restituant les options du select
- Tv de type checkbox
&listCheckTpl = chunk enveloppant les éléments de type="checkbox"
&listCheckItemTpl = chunk restituant les éléments de type="checkbox"
- Tv de type option("radio")
&listRadioTpl = chunk enveloppant les éléments de type="radio"
&listRadioItemTpl = chunk restituant les éléments de type="radio"

//ces derniers chunks ne devraient pas être utilisés
//je les retirerai certainement de la version finale
&hiddenTpl = chunk restituant les éléments de type="hidden"
&submitTpl = chunk restituant les éléments de type="submit"

Une série de chunks utilisés par défaut est livrée avec le module tvEditor

Gestion des filtres et personnalisation

Pour déterminer les filtres à utiliser pour chaque TV et ajouter/écraser/modifier certaines valeurs on utilise un chunk &chunkExtra
La création de ce chunk est obligatoire pour le bon fonctionnement du snippet.

La syntaxe à utiliser dans le chunk
nom_de_la_tv::nom_propriete==valeur_propriete
ex:tagsPhoto::filter==1::question==<h3>La photo doit contenir les tags suivants</h3>
Pour restituer "question" dans le chunk enveloppant la tv on devra rajouter le placeholder [+question+]

<fieldset>
[+question+]
[+listRadioItem+]
</fieldset>

Selection des TVs intégrées dans le formulaire et la recherche:

&selectTV= liste des noms des tvs séparés par une virgule
Ex: &selectTV=`tagsPhoto,typeRecette`

Parametre Ditto
&dittoName = nom du snippet ditto à utiliser
Les autres parametres sont ceux du snippet ditto.
Les parametres &tags, &tagData, &tagMode et &filter ne doivent pas être incorporés à l’appel.
Ces derniers seront créés par tvExplorer automatiquement.

Exemple d’utilisation:
Pour le bon fonctionnement du snippet, les valeurs des parametres doivent absolument être entourés de backticks(`) => param=`value`
Pour incorporer l’output du formulaire dans vos pages vous devez placer à la suite de l’appel de tvExplorer, le placeholder
[+tve.searchForm+]
La liste des résultats:
[+dittoList+]


Remarques:
Il n’y a ni mode debug ni de gestion d’erreurs pour l’instant
J’ai quelques soucis avec mon fournisseur d’accès depuis hier donc je vous envoie ce message depuis chez mes gentils voisins.
La situation devrait revenir à la normale la semaine prochaine aussi ne vous offusquez pas si je ne réponds pas à vos questions dans l’intervalle.

:-)

vivement la sortie de Ditto 2

La sortie de Ditto 2 étant imminente, est ce que l’un d’entre vous ayant de bonnes bases en anglais veut bien se charger de la traduction du post présentant le fonctionnement de tvExplorer.

je suis en train de finaliser la premiere beta publique du snippet et je manque de temps pour le faire.

Merci de votre aide.

:-)

bonjour heliotrope,

j’ai suivi le dev. de tvEditor/ Explorer et vous remercie de les proposer à la communauté. Peut-être maintenant je pourrais enfin aider avec un peut de traduction.
Je vie en france depuis une paire d’années malhereusement sans trop de maîtrise encore pour l’écriture en langue de molliere - je suis par contre anglais d’origine donc trad. Francais > anglais no problem.
Quelle post à traduire?

Liste complète des fonctionnalités et appel à contribution
http://modxcms.com/forums/index.php/topic,9812.0.html

ou ceci

tvExplorer : infos et fonctionnement
http://modxcms.com/forums/index.php/topic,11631.0.html

j’aurrais la possibilité ce soir.
lance

Merci Lance de ta proposition

C’est bien le premier post de ce thread qu’il faudrait traduire.(http://modxcms.com/forums/index.php/topic,11631.0.html)


Je te renouvelle mes remerciements.

:-)

bonjour,
ok cest fait, jai posté la http://modxcms.com/forums/index.php/topic,12258.msg81523.html#msg81523

j’espere que cest la ou tu le vouler

Salut Lance,

merci pour la traduction.
C’est vrai que je m’attendais plus a ce que tu postes dans ce thread
Le code n’étant pas prêt je prefererai attendre avant de demarrer un thread coté anglophone.

:-)

--Translation from french community http://modxcms.com/forums/index.php/topic,11631.0.html as asked by author heliotrope --

Hi folks,

While we’re waiting for ditto 2,0 to be released
Here’s a few details concerning tvExplorer.
I’ll post the code once ditto is available

tvExplorer
on line demo
sample 1=> http://www.dixsix.fr/explorer/
sample 2=>http://www.dixsix.fr/explorer/index.php?id=406

What’s it for:
tvExplorer is an extension for the module tvEditor. See => http://modxcms.com/forums/index.php/topic,7472.30.html TvExplorer permits the restitution on the front of tv’s (and their value options)depending on their type, in a search form.
The results list is obtained with ditto.
All of the filters representing the search criteria are automatically generated by TvExplorer,

Only these tv types are supported:
-text
-checkbox
-option
-listbox-multiple
-listbox-single
-listbox
-dropdown

TvExplorer parameters:

Html form output
The form html is made with chunks,
The form creation relies entirely on the class makeform by Jason(openGeek),

&formTpl: The form chunk
Must contain the following placeholders:
[+action+] => url or id
[+name+]=> form name
[+method+]=> form send method
[+tvEditorForm+] => Will be replaced by the form elements,

Eg:

<form action="[+action+]" name="[+name+]" id="[+name+]" method="[+method+]">
[+tvEditorForm+]
</form>

To produce the elements we will almost always use two chunks:
one to wrap the series of elements,
one to render each element,

Eg: A series of checkboxes
The wrapper &listCheckTpl, contains a placeholder ([+listCheckbox+]) which will be replaced by the tv options.


&listCheckTpl:

<fieldset>
[+listCheckbox+]
</fieldset>

Each checkbox is rendered using &listCheckItemTpl

&listCheckItemTpl:

<label class="checkbox" [+for+]>
<input class="checkbox" type="[+type+]" [+id+] name="[+name+]" [+value+][+size+][+checked+][+disabled+][+style+][+events+]/>[+label+]
</label>
[+extra+]

Eg: A series of radio
The wrapper &listRadioTpl, contains a placeholder ([+listRadioItem+]) which will be replaced by the tv options in the form of radio buttons.

&listRadioTpl:

<fieldset>
[+listRadioItem+]
</fieldset>

&listRadioItemTpl:

<label class="radio[+required+][+optional+]" for="[+name+]">
<input class="radio" type="[+type+]" id="[+name+]" name="[+name+]" [+value+][+size+][+checked+][+disabled+][+style+][+events+]/>[+label+]
</label>[+extra+]

etc ...

In short the parameters for form output are:

&formTpl = Main form chunk

- Tv type text
&mitTpl = wrapper chunk element type="text"
&inputTextTpl = render chunk element type="text"

- Tv type dropdown, listbox
&selectTpl = wrapper chunk element type="select"
&optionTpl = render chunk element select options

- Tv type checkbox
&listCheckTpl = wrapper chunk element type="checkbox"
&listCheckItemTpl = render chunk element type="checkbox"

- Tv type option("radio")
&listRadioTpl = wrapper chunk element type="radio"
&listRadioItemTpl = render chunk element type="radio"

// these last chunks will not be used
// i will probalbly remove them in the final version
&hiddenTpl = render chunk element type="hidden"
&submitTpl = render chunk element type="submit"

A series of chunks used by default comes with the module tvEditor,

Filter management and personalization
To determine the filters to use for each tv and add/overwrite/modify certain values we use a chunk &chunkExtra
The creation of this chunk is obligatory for the snippet to work.


The syntaxe to use in the chunk
tv_name:property_name==property_value

eg:
tagsPhoto::filter==1::question==<h3>The photo must contain the following tags</h3>

To render "question" in the tv wrapper chunk we must add the placeholder [+question+]

<fieldset>
[+question+]
[+listRadioItem+]
</fieldset>

Selection of the tv’s integrated in the form and search:
&selectTV= list of tv names separated by a comma
Eg: &selectTV=`tagsPhoto,typeRecipe`

Ditto Parameters
&dittoName = Name of Ditto snippet to use
The other parameters are from the ditto snippet.
The parameters &tags, &tagData, &tagMode and &filter should not be incorperated into the call.
These will be created by tvExplorer automatically.

Example of use:
For the correct operation of the snippet, the parameter values should always be wrapped with backticks(`) => param=`value`
To incorporate the output of the form in your pages the placeholder should be just after the tvExplorer call,
[+tve.searchForm+]
The result list:
[+dittoList+]


Remarks:
There is no debug or error management for the moment

by heliotrope

ok done - j’ai aussi enlever l’autre topic...

tu pense à diffusé dans quelque jours ou quelque semaines en beta.
je travail aussi sur la meme genre de chose (avec Eclispe404) - je ne sais pas si je suis assez performant en codage pour t’aider mais...
cest surtout de ne pas faire deux fois la meme choses.
Tu parler de budget une fois... j’ai les clients mais sans "demo" leurs poches sont trop loin.

C’est une question de jours

pour les demos en ligne il y a celles mentionnées dans le post.

:-)