Author: jcouteau Date: 2010-12-17 14:49:56 +0100 (Fri, 17 Dec 2010) New Revision: 137 Url: http://chorem.org/repositories/revision/bow/137 Log: Improve doc Added: trunk/src/site/rst/user/addBookmark.rst trunk/src/site/rst/user/preferences.rst trunk/src/site/rst/user/user.rst Removed: trunk/src/site/rst/user/token.rst Modified: trunk/src/site/rst/developper/installation.rst trunk/src/site/rst/index.rst trunk/src/site/rst/user/alias.rst trunk/src/site/rst/user/importExport.rst trunk/src/site/rst/user/openSearch.rst trunk/src/site/rst/user/search.rst trunk/src/site/site.xml Modified: trunk/src/site/rst/developper/installation.rst =================================================================== --- trunk/src/site/rst/developper/installation.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/developper/installation.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -28,6 +28,6 @@ Si vous souhaitez installer bow il vous suffit : - de télécharger le war à cette adresse : http://maven.chorem.org/release/org/chorem/bow -- de mettre le war dans le dossier webapps de tomcat +- de déployer ce war dans un conteneur d'aplpication (par example Tomcat). Le dépot des sources est à cette adresse : http://svn.chorem.org/svn/bow/ Modified: trunk/src/site/rst/index.rst =================================================================== --- trunk/src/site/rst/index.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/index.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -24,14 +24,50 @@ Bow === +Quoi qu'est-ce ? +---------------- + Bow (Bookmark On the Web) est une application web permettant la gestion de ses -marque-pages (bookmarks). +marque-pages (bookmarks) développée en Java. -Cette application vous permettra de consulter vos marque-pages où que vous soyez -et de n'importe quel ordinateur pourvu d'une connexion internet, mais aussi de -pouvoir en ajouter de nouveaux, les modifier ou les supprimer. +Et ça fait quoi ? +----------------- -Ce site vous donne accès à la documentation : +Bow vous permettra de consulter vos marque-pages où que vous soyez +et de n'importe quel ordinateur pourvu d'une connexion Internet. Vous pourrez +en ajouter de nouveaux, les modifier ou les supprimer. -- utilisateur: qui vous décrira chaque caratéristique du programme. -- développeur: qui s'adresse aux personnes désireuses de modifier des fonctionnalités ou d'en ajouter de nouvelles. +Classification +~~~~~~~~~~~~~~ + +La classification n'est pas effectuée, comme sur la plupart +des logiciels assurant les mêmes fonctions, sur un principe de dossiers, mais +sur un principe de tags. Ces tags permettent d'assurer une navigation dans les +marques-pages quelque soit le point d'entrée. Alors que sur une classification +par dossiers, un seul point d'entrée est possible. + +Recherche +~~~~~~~~~ + +Le principe des tags permet une recherche en entonnoir, ou recherche par +facettes, souvent observée sur les sites marchands, pour affiner la recherche. + +Recherche OpenSearch +~~~~~~~~~~~~~~~~~~~~ + +De plus en plus, les écrans se miniaturisent (netbooks, tablettes, ...). Aussi, +l'équipe a décidé de ne pas proposer de "barre d'outils" à rajouter à son +navigateur (ça prend de la place)mais plutot d'utiliser le principe +d'OpenSearch, permettant ainsi +d'utiliser la zone de recherche rapide de son navigateur. Comme tout le Web ne +peux être marqué dans Bow, il y a toujours besoin d'utiliser un moteur de +recherche. Et pour éviter de changer toutes les 2 secondes de moteur de +recherche dans la barre de recherche, vous pouvez déclarer un moteur de +recherche comme Seeks ou Google vers qui les recherches peuvent être redirigées. + +Ajout rapide de marque-pages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Comme on n'a pas forcément envie de s'identifier dans Bow pour rajouter un +marque-page, il est possible de marquer un lien dans son navigateur qui ajoute +la page consultée dans Bow avec les tags définis. \ No newline at end of file Copied: trunk/src/site/rst/user/addBookmark.rst (from rev 136, trunk/src/site/rst/user/token.rst) =================================================================== --- trunk/src/site/rst/user/addBookmark.rst (rev 0) +++ trunk/src/site/rst/user/addBookmark.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -0,0 +1,57 @@ +.. - +.. * #%L +.. * bow +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2010 CodeLutin +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU Affero General Public License as published by +.. * the Free Software Foundation, either version 3 of the License, or +.. * (at your option) any later version. +.. * +.. * This program is distributed in the hope that it will be useful, +.. * but WITHOUT ANY WARRANTY; without even the implied warranty of +.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. * GNU General Public License for more details. +.. * +.. * You should have received a copy of the GNU Affero General Public License +.. * along with this program. If not, see <http://www.gnu.org/licenses/>. +.. * #L% +.. - +===================== +Ajout de marque-pages +===================== + +Il est possible d'ajouter des marque-pages de deux façons : + +Formulaire d'ajout/modification +------------------------------- + +Le formulaire d'ajout/modification de marque-page vous permet d'ajouter +simplement un marque-page. + +Marque-page dans votre navigateur +--------------------------------- + +Il est possible de marquer les deux liens d'ajout présent sous le lien +"Preferences". + +Le lien "Bookmark add link (session)" se limite à la session (tant que vous êtes +identifiés sur le site). C'est le plus adapté aux situations de mobilité +(ordinateur d'un ami, ordinateur public, cyber-café,...) + +Le lien "Bookmark add link (permanent) est tout le temps valide. C'est le plus +adapté pour votre ordianteur personnel. + +Pour les faire fonctionner, il suffit de les ajouter comme marque page du +navigateur. Lorsque vous souhaitez enregistrer une page dans Bow, cliquez sur +votre marque-page, une fenêtre apparaît. Cette fenêtre comprend un seul unique +champ qui va vous permettre d'enregistrer votre marque-page. Il faut rentrer +les informations de la manière suivante :: + + Nom du marque-page|tag1 tag2 tag3 + +Une fois que vous avez validé, le marque-page est enregistré. Modified: trunk/src/site/rst/user/alias.rst =================================================================== --- trunk/src/site/rst/user/alias.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/user/alias.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -21,9 +21,9 @@ .. * along with this program. If not, see <http://www.gnu.org/licenses/>. .. * #L% .. - -===================== -Utilisation des alias -===================== +============================================== +Utilisation des alias / Service d'URLS courtes +============================================== Il est possible d'associer un alias à un marque-page et d'utiliser l'adresse de l'alias plutôt que celle d'origine. L'adresses de l'alias est de cette forme: Modified: trunk/src/site/rst/user/importExport.rst =================================================================== --- trunk/src/site/rst/user/importExport.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/user/importExport.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -21,22 +21,27 @@ .. * along with this program. If not, see <http://www.gnu.org/licenses/>. .. * #L% .. - -===================== -Importion/Exportation -===================== +============= +Import/Export +============= -Importation -=========== +Import +====== -Cette fonctionnalité vous permet d'importer des marque-pages depuis votre ordinateur. -Les marque-pages importés auront comme tags les noms des dossiers auquels ils appartenaient. -Le fichier à importer doit-être au format **HTML**. +Vous pouvez importer les marque-pages présents sur votre navigateur favori. Pour +pouvoir les importer dans Bow, vous devez au préalable les exporter, depuis +votre navigateur, au format **HTML**. -Pour importer un fichier il vous suffit de selectionner un fichier contenant vos informations -en cliquant sur "parcourir" puis de cliquer sur "import". +Pour importer votre fichier de marque-pages, sélectionnez votre fichier dans +la section "Import Bookmarks" avec le bouton "Parcourir..." puis validez avec +"Import". -Exportation -=========== +A noter que vos marques-pages auront pour tags les différents dossiers dans +lesquels ils ont été placés dans votre navigateur. -Pour exporter vos marque-pages, cliquez sur "Export bookmarks", votre fichier d'exportation -sera au format HTML. +Export +====== + +Pour exporter vos marque-pages, cliquez sur "Export bookmarks" sous la section +d'import. Votre fichier d'exporter sera au format HTML afin de pouvoir le +réimporter dans un navigateur. Modified: trunk/src/site/rst/user/openSearch.rst =================================================================== --- trunk/src/site/rst/user/openSearch.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/user/openSearch.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -21,16 +21,49 @@ .. * along with this program. If not, see <http://www.gnu.org/licenses/>. .. * #L% .. - -========== -OpenSearch -========== +==================================== +OpenSearch/Barre de recherche rapide +==================================== -Il est possible d'utiliser le moteur de recherche de bow dans la barre de recherche -rapide du navigateur. Pour pouvoir l'ajouter il faut se connecter, puis choisir soit -le moteur de recherche permanent ou temporaire. Le temporaire ne dure que le temps -d'expiration de la session. Une fois ajouté vous pouvez l'utiliser à n'importe quel -moment. +Moteur de recherche de Bow +~~~~~~~~~~~~~~~~~~~~~~~~~~ -Vous pouvez aussi effectuer une recherche mais cette fois ne pas utiliser le moteur de -recherche de bow mais celui que vous avez défini au préalable. Pour cela préfixé -votre recherche de **":s"**. +Il est possible d'utiliser le moteur de recherche de Bow dans la barre de +recherche rapide du navigateur. Pour pouvoir l'ajouter il faut se connecter à +Bow, puis choisir soit le moteur de recherche permanent ou temporaire. +Le temporaire ne dure que le temps d'expiration de la session. Une fois ajouté +vous pouvez l'utiliser à n'importe quel moment. + +Moteur de recherche externe +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Vous pouvez aussi effectuer une recherche en utilisant un moteur de recherche +externe. Cela vous permet de ne pas changer toutes les 2s de moteur de recherche +dans votre barre de recherche rapide. + +Choisir son moteur de recherche externe +--------------------------------------- + +Vous pouvez choisir votre moteur de recherche externe dans les préférences de +l'application. + +Renseignez les champs **Search Engine URL Suggestions** et **Search Engine URL +Results**. + +Search Engine URL Suggestions correspond à l'URL retournant les propositions de +recherche. Vous savez, quand vous tappez wiki on vous propose Wikipedia,... + +Search Engine URL Results correspond à l'URL retournant les résultats. + +Pour que tout cela fonctionne bien, il faut dire ou placer les termes de la +recherche, pour cela utiliser **{searchTerms}**. Bow le remplacera par vos +termes de recherche. + +Effectuer une recherche avec le moteur externe +---------------------------------------------- + +Pour cela préfixez votre recherche de **":"**. Par exemple, si je recherche:: + + :bow + +Cela recherchera bow dans mon moteur de recherche préféré. Added: trunk/src/site/rst/user/preferences.rst =================================================================== --- trunk/src/site/rst/user/preferences.rst (rev 0) +++ trunk/src/site/rst/user/preferences.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -0,0 +1,15 @@ +=========== +Préférences +=========== + +Dans vos préférences, vous pouvez changer votre mot de passe ou votre adresse +mail. + +Vous pouvez égalment regénérer votre token permanent. Cela correspond à votre +identifiant de sécurité utilisé dans la barre de recherche rapide et le +marque-page d'ajout. Vous devrez alors les réinitialiser. + +C'est également sur cette page que vous pouvez déterminer le nombre de +marque-pages affichés sur la page d'accueil de bow, la couleur du site, +le nombre de tags affichés dans le nuage et les URLs de votre moteur de +recherche externe préféré. \ No newline at end of file Modified: trunk/src/site/rst/user/search.rst =================================================================== --- trunk/src/site/rst/user/search.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/user/search.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -31,11 +31,12 @@ - Recherche par tags: La recherche par tag va rechercher les marque-pages en fonction des tags qu'ils possèdent. Il est possible de les taper manuellement ou de cliquer sur les tags - du nuage de tags et ainsi d'effectuer une recherche en entonoire. + du nuage de tags permettant d'affiner la recherche. - Recherche intégrale: La recherche intégrale va retourner tous les marque-pages qui possèdent un des - mots clés tapés dans la barre de recherche. + mots clés tapés dans la barre de recherche, que ce soit dans les tags, dans le + nom ou l'URL. -Ces deux types de recherche retournent, si la recherche est vide, les marque-pages -qui ne possèdent aucun tag. +Ces deux types de recherche retournent, si la recherche est vide, les +marque-pages qui ne possèdent aucun tag. Deleted: trunk/src/site/rst/user/token.rst =================================================================== --- trunk/src/site/rst/user/token.rst 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/rst/user/token.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -1,39 +0,0 @@ -.. - -.. * #%L -.. * bow -.. * -.. * $Id$ -.. * $HeadURL$ -.. * %% -.. * Copyright (C) 2010 CodeLutin -.. * %% -.. * This program is free software: you can redistribute it and/or modify -.. * it under the terms of the GNU Affero General Public License as published by -.. * the Free Software Foundation, either version 3 of the License, or -.. * (at your option) any later version. -.. * -.. * This program is distributed in the hope that it will be useful, -.. * but WITHOUT ANY WARRANTY; without even the implied warranty of -.. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.. * GNU General Public License for more details. -.. * -.. * You should have received a copy of the GNU Affero General Public License -.. * along with this program. If not, see <http://www.gnu.org/licenses/>. -.. * #L% -.. - -===================== -Ajout de marque-pages -===================== - -Il est possible d'ajouter des marque-pages de deux façons par l'intermédiaire: - -- Du formulaire d'ajout/modification. - -- Des liens d'ajout de marque-pages (session et permanent) : - Ces liens permettent l'ajout de nouveaux marque-pages sans avoir - à se connecter au site. Il suffit d'ajouter ces liens à vos favoris - puis cliquez dessus lorsque vous souhaitez enregistrer une page. Une - fenêtre apparait, complétée là et le tour est joué! - -Il existe deux types de lien, un qui n'est valable que le temps d'expiration de la session -(pratique si vous utilisez temporairement un ordinateur) et l'autre de manière permanente. Added: trunk/src/site/rst/user/user.rst =================================================================== --- trunk/src/site/rst/user/user.rst (rev 0) +++ trunk/src/site/rst/user/user.rst 2010-12-17 13:49:56 UTC (rev 137) @@ -0,0 +1,16 @@ +Documentation utilisateur +========================= + +* `Importer ses marque-pages`_ +* `Rechercher dans ses marque-pages`_ +* `Ajouter des marque-pages`_ +* `Créer des URLs courtes de ses marque-pages`_ +* `Faire des recherches depuis sa barre de recherche rapide`_ +* `Gérer ses préférences`_ + +.. Importer ses marque-pages:: importExport.html +.. Rechercher dans ses marque-pages:: search.html +.. Ajouter des marque-pages:: addBookmark.html +.. Créer des URLs courtes de ses marque-pages:: alias.html +.. Faire des recherches depuis sa barre de recherche rapide:: openSearch.html +.. Gérer ses préférences:: preferences.html \ No newline at end of file Modified: trunk/src/site/site.xml =================================================================== --- trunk/src/site/site.xml 2010-12-10 15:55:34 UTC (rev 136) +++ trunk/src/site/site.xml 2010-12-17 13:49:56 UTC (rev 137) @@ -29,25 +29,23 @@ <bannerLeft> <name>${project.name}</name> + <href>index.html</href> </bannerLeft> <body> - <menu name="Utilisateur" inherit="top"> - <item name="Utilisation de bow"> - <item name="Importation/Exportation" href="user/importExport.html" /> + <menu name="Utilisateur"> + <item name="Import/Export" href="user/importExport.html" /> <item name="Recherche de marque-pages" href="user/search.html" /> - <item name="Ajout de marque-pages" href="user/token.html" /> - <item name="Utilisation des alias" href="user/alias.html" /> + <item name="Ajout de marque-pages" href="user/addBookmark.html" /> + <item name="Alias/URL courtes" href="user/alias.html" /> <item name="OpenSearch" href="user/openSearch.html" /> - </item> + <item name="Préférences" href="user/preferences.html" /> </menu> - <menu> - <item name="Développeur"> - <item name="Presentation" href="developper/presentation.html" /> - <item name="Installation" href="developper/installation.html" /> - </item> + <menu name="Utilisateur"> + <item name="Presentation" href="developper/presentation.html" /> + <item name="Installation" href="developper/installation.html" /> </menu> <menu ref="reports"/>