Aide de Slogger

Version 0.5

Prise en mains rapide

• Installation
  Installer Slogger, et redémarrer Firefox.
• Ajouter le bouton
  Pour ajouter le bouton Slogger à la barre d'outils : Affichage >>> Barres d'outils >>> Personnaliser... , trouvez le bouton et déplacez le où vous le souhaitez sur la barre d'outils.
• Activer
  Cliquez sur le bouton pour qu'il devienne rouge (Cette opération active la journalisation de toutes les pages)
• Choisir un dossier
  Ouvrir n'importe quelle page dans Firefox. Un message devrait vous demander de définir un dossier - le dossier peut aussi être défini dans les options - une fois le dossier choisit, Cliquez sur OK. Vous pouvez laisser les options par défaut
• Utilisez le !
  Naviguez sur quelques pages internet.
  Cliquez sur le petite flèche verte a coté du bouton Slogger. Choisissez "Ouvrir les fichiers journalisés récemment".
  

C'est le comportement standard, les opérations par défaut. Mais le but est de rendre Slogger extrêmement configurable. Si le comportement standard ne vous suffit pas, vous pouvez le personnaliser. Ce document explique les différentes options disponibles.

Contenu

• Quoi ?
• Pourquoi ?
• Comment ?
  
• Options
  • Noms de fichier
  • Journal
  • Variables
  • Variable de sélection
  • Confirmation/Edit Popup
  • Filtres
  • Services
  • Boutons
  • Utilisez différentes options pour différentes pages
  • Scripting
• Exemples
  • XML Complete
  • HTML - Personal and HTML - Business
  • Minimal
  • CSV w/ sauvegarde manuelle
  • StumbleUpon CSV and StumbleUpon XML
• A faire
  

I. Quoi ?

Slogger est une extension pour le navigateur Mozilla Firefox. Elle peut :

• Crée un enregistrement complet de votre historique de navigation.
  
• Sauvegarder une copie de chacune des pages que vous avez visité sur votre dique dur et/ou sur an archive provided by an online service
• Créer un fichier texte personnalisable contenant l'historique des pages que vous avez visité

Peut-être que les futures versions de Slogger contiendront des outils pour voir/trier/gérer/etc.. toutes les données qu'il accumule, mais l'idée principale est de stocker toutes les données de telle manière que vous puissiez facilement employer d'autres programmes pour les traiter.

II. Pourquoi ?

Les applications suivantes sont populaires :

• Archivage / Recherche personnelleEnregistrez en ligne des informations et des évènements. Rechercher des pages enregistrées localement en utilisant des outils comme Google Desktop, et des pages enregistrées sur internet en utilisantFurl, Spurl et/ou My Yahoo! Search. Utilisez plusieurs services pour éviter les pertes de données.
• Historique Texte Archivez votre historique dans un fichier texte personnalisable, dans de nombreux formats (XML, HTML, CSV, etc.) dont vous avez besoin..
• Lecture hors ligne Enregistrez les pages que vous souhaitez revoir hors ligne, pratique pour les petites connections.
• Recherche Journalisez vos recherches sur internet afin de vous constituez une banque de données complètes, et ne plus perdre de temps à refaire une recherche.
• Blogging Utilisez des servies comme StumbleUpon, Spurl, del.icio.us, Furl et/ouMy Yahoo! Search pour publier ce que vous trouver sur internet dans votre Blog.

III. Comment ?

Slogger est compatibile avec Firefox 0.9 ou supérieur. L'extension est disponible sur  update.mozilla.org et sur ce site. Aller voir la section Prise en main rapide pour les instructions d'installation.

IV. Options

Si c'est votre première utilisation de Slogger, vous désirerez peut être conserver les options par défaut, afin de vous familiariser avec son utilisation. Une fois familiarisé avec Slogger, la lecture des différentes options devrait vous donner une bonne idée de leur fonctions. Si vous faîte une mise à jour à partir d'une précédente version, vous devriez réinitialiser les options par défaut au cas ou leurs noms changeraient. Vous trouverez ci dessous quelques notes concernant diverses aspect de Slogger :

Noms de fichier

• Page Sauvegardée Notez que le nom du fichier par défaut de la page sauvegardée possède un enregistrement daté incluant l'heure à la milliseconde près à laquelle il a été enregistré. Inclure ces informations dans le nom du fichier vous assure que le nom du fichier est unique. Si les noms de fichier n'était pas uniques, il serait impossible de les afficher correctement. Notez que les dossiers et leurs données sont stockés dans un sous-répertoire « données » du répertoire principal de Slogger. Ceci vous permettre de consulter le contenu du répertoire de Slogger directement dans Firefox et voir ainsi les enregistrements sans patauger dans d'autres répertoires.
• Fichier Log D'autre part, vous ne voudrez probablement pas que le fichier Log soit unique pour chaque enregistrement puisque le fichier Log est appellé à chaque fois que vous utiliser Slogger. Si vous conservez le paramétrage par défaut concernant les informations date/heure, alors un nouveau fichier de log sera créé chaque jour. De même, vous pourriez affecter au paramètre $year.log, du fichier Log de Slogger une constante, etc. Ou employer le paramètre $host.log pour créer un dossier de Log séparé pour chaque centre serveur visité (par exemple www.amazon.com, etc.).

Enregistrement du fichier Log

La zone de texte du fichier Log contient le texte qui sera ajouté au fichier Log chaque fois qu'une page sera enregistrée. Allez visiter section exemple pour plus d'information.

Variables

• Index Un clic sur le bouton « Variables. » affiche une liste de toutes les variables disponibles. Slogger remplace simplement n'importe quelle occurrence de la liste « $varnom » avec la valeur appropriée.
• Sélection Si vous selectionnez un texte avant de journaliser la page, la selection est copiée dans la variable $clip.

Confirmation/Edition des Popup

Deux boites de dialogues existe. La boites de confirmation de journalisation vous permet d'ajouter un mot-clef ou une description de la page à journaliser. Elle permet aussi de changer le nom du journal pour chaque page enregistrée. You can toggle the Confirm Log dialog on an off using the Confirm item of the drop-down menu. You can also enable and disable it via the 'Prompt for confirmation/details' checkbox on the Log File, Save Pages and Services tabs of the Options dialog.

La prévisualisation du journal vous permet d'éditer le texte entier avant de le créer. Vous pouvez activer ou désactiver cette fonction en cochant 'Avertissement pour confirmation/détail' dans les options d'enregistrement d'une page.

Filtres

Les options de l'onglet Filtres should be fairly straightforward. The option to skip logging a page within x seconds avoids creating duplicate entries for pages that contain internal frames or certain meta tags. Specifying a large value there will prevent Slogger from logging the same page twice in a row when you refresh the page or if the page automatically refreshes.

Services

• Vous devez bien-sûr créer un compte sur un des sites qui propose ce service  proposés avant d'utiliser cette fonction dans Slogger.
• Chaque fournisseur personnel de recherche/Marque-pages offre ses propres outils pour journaliser des pages, mais Slogger n'utilise pasces outils.
• A chaque utilisation de Furl, Spurl ou  My Yahoo! Search, Slogger ouvrira un pop up de connection. Furl et Spurl peuvent se configurer de manière a ne plus avoir besoin du nom d'utilisateur et du mot de passe, mais vous en aurez toujours besoin pour My Yahoo! Search.
• Si vous obtenez des messages d'erreurs d'envoi de données, votre fournisseur d'accés ne répond pas assez rapidement. Pour résoudre ce problème, tapez "about:config" dans la barre d'adresse et augmentez la valeur de "slogger.submitAutoRetryCount" (a taper dans le champ filtre pour éviter une recherche fastidieuse). La valeur par défaut est 1, essayer de mettre 2 ou 3. Un autre remère est de changer de la même manière "slogger.submitConnectionTimeoutInterval" : la valeur par défaut est 10000 (qui correspond a 10 secondes); essayez 15000.
• Si les requètes n'aboutissent jamais avec del.icio.us, vérifier votre nom d'utilisateur et votre mot de passe. (Slogger ne prévient pas d'une erreur de ce genre)
• Si les requètes n'aboutissent pas par intermittence avec del.icio.us, il se peut que ce service soit indisponible pour le moment (ou trop occupé). Vous pouvez utiliser le service Spurl qui offre la possibilité d'intégrer les services de del.icio.us. Vous pouvez aussi  augmenter la valeur de "slogger.submitConnectionTimeoutInterval" comme expliquer précédement.
  

Boutons

Slogger comporte jusqu'a 5 boutons et 3 champs contextuels. Chaque dispositif est optionnel, est configurable dans les options (onglet bouton d'un profil) et peut avoir un comportement différent suivant le mode de journalisation choisit (auto ou simple). Vous pouvez utiliser les bouton pour charger un page-journal, pour éxecuter un script ...

Utilisez différentes options pour différentes pages

Slogger users commonly want to log different pages differently. For example, suppose that you want to log most noteworthy pages without being prompted for keywords but that you want to be prompted for a keywords for certain pages. Or suppose that you want to create a log file entry for all noteworthy pages but that you want to save only certain pages to your hard drive. Or suppose that you want to submit all noteworthy pages to Furl and Spurl but that you want to rate only certain pages via StumbleUpon. An obvious method to satisfy these requirements is to configure multiple profiles and to change to the appropriate one before logging. A less obvious (and more efficient) method is to create multiple profiles, to choose one profile to be your primary profile and to configure each button of the primary profile to invoke the 'log current page' behavior for a secondary profile.

If you choose the first method, you may find it helpful to show the label for the Main button and to set it to something descriptive. If you do this for each commonly used profile, you won't have to open the drop-down menu in order to determine which profile is currently selected.

If you choose the second method, realize that "primary" and "secondary" don't refer to something that you set on the Options dialog: You can treat any profile as the primary profile; it's simply the profile that remains selected and that determines your auto-logging settings. Here are some tips for configuring a primary profile:

• Take a moment to plan how each button and context menu item of your primary profile will be used. Note that visibility of Dyn buttons and Mouse context menu items can change automatically when you change profiles; whereas, Main, Slogger A and Slogger B buttons remain visible regardless which profile is selected. Note also that Dyn buttons are always adjacent to the Main button; whereas, Slogger A and Slogger B buttons can be located anywhere on the toolbar.
• To make a button invoke a profile other than the current profile, just check the 'Log current page using profile:' checkbox, and choose the relevant profile from the drop-down list.
• After you select the profile that a button will invoke, you may want to show its label and to set the label to something shorter or more evocative than the default.

Scripting

Three types of script exist. All of them are browser scripts written in JavaScript, but the various types are invoked by different events and run in different contexts. Button scripts comprise the most conventional type. A button script gets run when the relevant button is clicked. Profile scripts are the type most useful for adding browser functionality. The profile load script for the selected profile runs when the browser starts, so it can be used to script behavior of Firefox on startup. If you use the profile load script to modify Slogger behavior, you can use the profile unload script to restore the default state. (See either of the StumbleUpon default profiles for an example.) Format scripts are the most specialized type. A format script runs immediately before Slogger submits to a service. See the format script help for details and examples.

• If you create a script related to logging that you believe other Slogger users may find useful, consider posting it to the Slogger mailing list.
• To run a program, use the utility function slogger_systemExec(commandString, argumentsString). For example in Windows, the following statement opens the current log file in Notepad: slogger_systemExec("C:\\WINDOWS\\notepad.exe", sloggerPrefs.getPref("mostRecentLogFile"));. (The double backslashes are required because blackslash is an escape character in JavaScript.)
• The window object isn't the DOM window that a client-side script sees. Instead, it's the browser's XUL window. To access the DOM window and document, use convenience variables win and doc. For example, the following statement writes the title for the current page to the JavaScript Console: slogger_writeConsoleMessage(doc.title);. Alternately, you can use slogger_writeConsoleMessage(getBrowser().contentWindow.document.title);.
• To access browser elements, use document.getElementById(element-id-string). For example, one way to open the Find bar is document.getElementById("cmd_find").doCommand();.
• Three other useful utility functions are slogger_changeProfileByName(profileNameString), slogger_escapeXML(string) and slogger_formatCSVString(string).
• Scripts run in the context of the slogger object for the current browser window. In other words, this is equivalent to window.slogger.

V. Exemples

Lors de la première installation de Slogger, des profils par défaut sont creé. Ces derniers vous donnent une idée des différentes possibilités de Slogger. Le mieux est de personaliser ces profils afin de comprendre le fonctionnement de Slogger, puis de créer un profil personalisé complet suivant vos besoins.

• XML Complet
Utiliser les étiquettes pour sauvegarder toute les informations disponible dans les variables. Écrivez un titre d'en-tête et de bas de page, sans utiliser de caractères spéciaux, ainsi le fichier Log XML devrait être valide. En outre, il créera un fichier XSL qui est utilisé pour composer le fichier XML visualisable dans un navigateur.
• HTML - Personnel et HTML - Business
Ces deux profils créés un fichier de log en HTML. cet exemple montre aussi comment vous pouvez enregistrer deux profils différents dans le même fichier Log. Il génèrera un fichier CSS.
• Minimal
  Sauve juste le nom de fichier de la page sauvée et l'URL dans un fichier texte. Si le nom de fichier contient des informations de type date/heure (comme il le fait avec les options par défaut) et que vous sauvegardez la page, alors toutes les autres informations pourront être extraite juste à partir de ces deux variables et de la page sauvegardée.
• CSV w/ manual saving
  'Saves history info in a comma-separated value (CSV) file. CSV is a plain text format readable by many spreadsheets and databases. It also illustrates auto-logging combined with manual saving: The Slogger Get button toggles auto-logging, while the main button saves the page.
• StumbleUpon CSV and   StumbleUpon XML
  Ces profils necessite l'extension StumbleUpon Toolbar. Chaque variante fait ce qui suit:
  • rating buttons Tles boutons Dyn A et Dyn B  se comporte comme les boutons "rating" de l'extension StumbleUpon.
    
  • quote blogging Selectionner le texte à ajouter dans votre blog.
  • relocatable Stumble button Le bouton Slogger A se comporte comme le bouton Stumble! de l'extension.
    
  • configurable Variables at the top of the profile load script control options.
  These profiles illustrate using scripting to perform one-click logging and processing. See also the scripting section.

VI. A faire

• Ajouter plus de variables : taille du document, taille du document + fichiers, type de document, obtenir l'extension de fichier, ...
• J'aimerais vraiment pouvoir enregistrer une miniature de chaque page ... mais je ne suis pas sûr que cela soit possible.
• More intuitive and attractive icons would be nice. Suggestions regarding alternatives to the arrows are welcome. And help creating anti-aliased icons both for the buttons and for the Extensions dialog would be greatly appreciated.
• A configurable keyboard shortcut for each button would be nice. (They'd have to be configurable because choosing convenient fixed ones that won't conflict with various platforms and with various extensions is virtually impossible.)
• Making button icons configurable (in cases where the button mode isn't set to 'Toggle auto-logging') would be nice.

Site web de Slogger