tvExplorer: documentation [obsolete]

Cette documentation n’est plus le reflet du snippet actuel

Hello à tous

Voici la liste des paramètres de tvExplorer, je diffuserai bientot les sources.
Pour pouvoir éxécuter tvExplorer vous devrez au préalable installer tvEditor (je posterai le detail des fonctionnalites plus tard)



Les parametres de tvExplorer :

Les snippets éxécutés depuis tvExplorer pour son bon fonctionnement

&dittoName => nom du snippet ditto dans votre base de données.
=> valeur par defaut: Ditto
=>Parametre de ditto
- &dittoSnippetParameters => fonctionnement identique a reflect
- Ex: &dittoSnippetParameters=`tpl:monChunk|paginate:1|display:10`

&as_snippet => nom du snippet tve_AjaxSearch dans votre base de données.
=> valeur par defaut: tve_AjaxSearch

Les Tvs a afficher dans le formulaire

&selectTV => liste des noms des tvs séparés par une virgule
&extraTVs = tvs a qui ne font pas partie du formulaire
mais que vous souhaitez afficher dans votre tpl Ditto par l’intermediaire du placeholder tagLinks de Ditto
&excludeTvs = les tvs a eliminer de la recherche full text

Affichage du champs mots clés :

&keywordsSearch => active l’affichage d’un champ texte pour la recherche de mots cles
&keywordsLabel => le label du champ de recherche

Affichage de l’arbre de documents

&parentElt=>Active l’affichage d’un select contenant la liste des folders d’un repertoire.
Ex: &parentElt=`field:menutitle|start:0|depth:3|label:Choisissez une rubrique|blankLabel:-`
=>parametre
- field: la propriete du document a afficher dans le select
- start: le folder a partir duquel on commence l’exploration.
- depth: La profondeur du select a partir du start.
- label: le label du select.
- blankLabel: la valeur a afficher pour la premiere option vide.

Parametres d’affichage et proprietes du formulaire

&formID => ID du formulaire
&searchLabel => Valeur du champ submit du formulaire
&formTpl => chunk du formulaire
&listInputText => chunk dans lequel les éléments de type texte seront affichés
&inputTextTpl => chunk pour les éléments de type text
etc ...
On peut determiner pour chaque type d’élément un chunk a utiliser
La logique de présentation est la suivante.
Un chunk parent pour la tv contenant un placeholder [+tve.wrapper+]
qui sera remplacé par les options de la TV restitués selon le type de la TV

Insertion de fichier Css et Js

&cssStyle => liste des fichiers css séparés par une virgule
&jScript => liste des fichiers js séparés par une virgule

Parametres d’affichage et de filtrage pour chaque Tv

Ils sont fixés dans un chunk qui est obligatoire
&extraChunk=`nomduChunk`

la syntaxe a utiliser dans le chunk est :
nomTV::param1==value1::param2==value2::param3==value3

On peut de cette façon fixer les paramètres suivants
=>pour chaque tv
-outerTpl=> chunk entourant les options de la Tvs généralement il s’agit d’un fieldset
(si specifier il ecrase les parametres d’affichage fixés plus haut)
-filter => le filtre a appliquer a cette TV (voir logique des filtres de tvExplorer)
-filterOff => filtre complémentaire pour produire une recherche TV1 AND TV2 AND TVn et non TV1 OR TV2 OR TVn
- tvType si vous souhaitez changer le type de la TV fixé dans le manager sur le front
-label => le label de la TV
-class => la valeur remplacera le placeholder [+class+] (sous la form class="valeur" )situé dans le chunk de la TV
-classname => la valeur remplacera le placeholder [+className+]
- etc ...
Si vous souhaitez activer une requete SQL pour une recherche fullText sur une TV de type text
=>fullText==true

Les autres placeholders
- extra => si vous souhaitez afficher des infos supplementaires dans le fieldset
- question =>
- before
- after
- tabName
- tabLabel

Vous pouvez également accèder aux propriétés des options de la la TV en préfixant les params avec c_
parmi les proprietes
- class
- blankLabel > pour les TVs de type dropdown ou select (ou bien celle ayant une valeur vide fixée dans tvEditor)
- size
- maxlength
etc ...


Exemple d’appel

[!tvExplorer?
&dittoName=`Ditto`
&dittoSnippetParameters=`tpl:myTpl|depth:5|parents:10,20|display:25|extenders:date,summary`
&parentElt=`start:4|level:2|type:select|field:pagetitle`
&extraChunk=`myExtraChunk`
&selectTV=`tv1,tv2`
&searchLabel=`Search`
!]

Dans votre document ou votre template

[!tvExplorerCallWithParams!]
[+tve.searchForm+]
[+tve.dittoList+]


Demo en ligne:

http://www.deco-in.com/recherche-avancee

:-)

P.S: tvExplorer supporte les @BINDINGS @SELECT & @CHUNK (si vos options y sont stockées)
Les tvs de type listbox, listbox-multiple, text, number, dropdown, radio et checkbox

Si quelqu’un se sent de traduire la doc en anglais je l’en remercie par avance

Pour la trad si ça peut attendre genre 2/3 semaines, je suis volontaire... sinon je peux aider à la relecture correction si quelqu’un d’autre veut s’y coller avant Voilà un snippet qui va faire un malheur côté anglophone ce serait dommage de ne pas offrir une traduction digne de ce nom (en plus de réduire le support qui va découler de son adoption massive, nul doute...).

Je pense qu’il va y avoir un petit apprentissage mais la doc donne déjà une idée de la logique (assez familière, ouf !). Merci !

Salut david,

Il n’y a pas urgence pour la traduction d’autant que je vais lever le pied sur les dernieres fonctionnalites.
Je suis vanné

D’autant que tvexplorer n’est que la partie visible de tvEditor dont je viens de finir le formBuilder en ajax ;-)
Encore quelques détails à régler et je diffuserai le tout.

:-)

formBuilder en ajax ?
Mais jusqu’où iras tu ? ? ?

Je comprend que tu sois vanné, dis moi c’est du plein temps là tvExplorer / tv Editor, ces dernière semaines ?
En tout cas, ça va être une des extensions clé de MODx, je le sent déjà !

Alors Levons un coin du voile sur tvExplorer cote Manager
Ce n’est qu’une partie des fonctionnalites de tvEditor dont la principale mission est d’offrir une GUI à la gestion des options des TVs


Etape 1: Selection du template



Etape 2: Selection des TVs(associées a ce template) à afficher dans le formulaire de recherche



Etape 3 affichage des resultats
On peut limiter la recherche au folder de son choix en cliquant dans l’arbre de documents
et aux valeurs des options sélectionnées dans le formulaire



Etape 4 edition des valeurs des TVs des documents de la liste avec QE
En cliquant sur les tags(valeur ou nom si pas de valeurs)
On peut egalement acceder a la page d’edition du doc avec un clic sur editer, previsualiser la page, ...



Toutes les étapes s’effectuent sans recharger la page grace a AJAX.

Je comptais ajouter la possibilité d’enregistrer les formulaires ainsi créés mais bon ...



:-)

Je ne pensai pas qu’on pouvait même éditer les valeurs des TV avec QuickEdit !

Wahhhhhh... j’imagine déjà les portes que cela va ouvrir

Je me doute que personne n’avait commencé la trad et c’est tant mieux.
Cette documentation est obsolete

depuis j’ai revu le mode de creation du formulaire on est desormais dans la lignee de ce qui se fait avec eForm.

:-)

Hi everyone, sorry to speak in English but someone pointed me here as it may be the answer for something I am trying to achieve, could anyone point me to English documentation for this and a download link?

Thanks.

Jose R. Lopez

Hi Jose, the module is being completed as we speak, the documentation is not ready yet but I’ll handle the translating to english as fast as possible and post something on the english boards when I do

Merci david de te proposer pour la traduction.
Je suis en train de finaliser le module.
Je vais profiter de ce jour férié pour régler les derniers détails.

Une fois prêt pour une beta publique je posterai la doc en francais et lorsque tu auras le temps tu pourras la traduire afin que l’on puisse poster du coté anglophone.

J’avais commencé la doc mais j’ai modifié le code de telle sorte qu’elle est désormais obsolète.

A présent on écrit le formulaire en html et on intégre des tags spécifiques pour les tvs qui serviront de critères de recheche
Ca donne

[+tve.nomDeLaTV:filter->7:tvtype->dropdown:label->Label de ma tv:class->classCss+]

Ici le param tvtype permet de changer le type de la tv pour le front.
On peut également invoquer une méthode spéciale appelée RANGE.
Elle permet d’établir un intervalle de recherche idéal pour un prix par exemple.

[+tve.tvPrixProduit:#RANGE{tvtype->dropdown:elements->@CHUNK mesPrix:filter->3||tvtype->dropdown:elements->@CHUNK mesPrix:filter->4}+]

Dans cet exemple on va créer deux dropdown dont les options viennent d’un chunk pour établir un intervalle dans lequel devra se trouver le prix de l’objet.
Dans le chunk mesPrix on pourrait par exemple ecrire:
Moins de 10 euros==10||Entre 10 et 20==20||etc ...
Pour RANGE tous les @BINDINGS sont supportés (@SELECT, @EVAL, ...) .
J’en ai également ajouté un nouveau @TV => les options de l’intervalle sont celles de la TV elle même

On peut aussi déclencher une recherche full text sur une tv avec le param fullText->1

[+tve.maTV:fullText->1+]

Etc ...

Il y a également des placeholders avec des fonctionnalités préétablis comme keywordSearch et ParentElt

keywordSearch => execute une recherche fullText sur les champs du doc et sur ttes les TVS (identique a la AjaxSearch en fait)

[+tve. keywordSearch:searchStyle->partial:excludeTV->all+]

Ici on restreint la recherche aux seuls champs de l’objet document en excluant les TVs de la recherche.

ParentElt sert à restituer l’arbre de documents sous la forme d’un select pour limiter la recherche à un folder et ses enfants en particulier

[+tve.ParentElt:depth->4:start->25:field->menutitle+]

dans cette commande on crée un select qui rassemblera tous les folders contenu dans le folder 25 sur 4 niveaux et le champ affiché dans la liste sera menutitle.

etc ....

A suivre


:-)