Sommaire

Sommaire
Généralités
1. NB_EDITOR
2. NB_BROWSER
3. MAX_ENTRIES
4. DATE_FORMAT
5. DATE_LOCALE
6. DATE_ARGS
7. BLOG_URL
8. BLOG_CSS
9. BLOG_ICON
10. BLOGURLACTION
11. BLOG_CHARSET
12. BLOG_MIMETYPE
13. BLOG_TZD
14. BLOG_TITLE
15. BLOG_DESCRIPTION
16. BLOG_AUTHOR
17. BLOG_CONTACT
Divers
Préférences pour les liens
Archives
Plugins
Syndication
Articles
1. ARTICLES_DIR
2. ARTICLES_FORMAT
Cache
1. MAX-CACHE-ENTRIES
2. BLOG-CACHEMNG
Sécurité
1. NB-TEMP-DIR
2. NB-UMASK

Généralités

NB_EDITOR

Cette variable détermine l'éditeur (ou le traitement de texte) qui sera automatiquement appelé par nb dès qu'il s'agira d'écrire un nouveau billet ou article. On n'est pas obligé de modifier cette entrée : l'éditeur vi en standard sur tous les systèmes sera probablement invoqué. À tout hasard, regardez dans votre environnement, à quel éditeur fait référence EDITOR en entrant dans votre console: env, c'est celui-ci qui sera invoqué. Mais si vous n'êtes pas en liaison SSH ou TELNET et que vous avez ouvert une console au sein d'un bureau en mode graphique (comme Gnome ou KDE) vous pouvez avantageusement mettre la commande d'un joli traitement de texte. Par exemple pour Kwrite entrez :

NB_EDITOR="kwrite"

Une fois votre billet ou article édité, enregistrez et quittez l'éditeur. NB reprendra la main automatiquement et continuera le processus. L'avantage d'invoquer un joli traitement de texte ne se situe pas seulement au niveau du confort; vous pouvez aussi employer ses capacités à générer du source HTML ou vérifier votre orthographe...

NB_BROWSER

Cette variable va invoquer le navigateur Internet si vous avez demandé à visualiser votre entrée en cours. Par défaut lynx est appelé. Vous pouvez aussi mettre pour le mode console : links, elinks ou w3m. Pour le mode graphique: n'importe lequel des grands classiques comme Firefox :

NB_BROWSER="firefox"

Cette commande n'a d'intérêt que pour ceux qui veulent visualiser leurs pages avant que d'entamer le processus de transfert vers le serveur. Ceux qui agissent directement sur le serveur et qui ont déjà ouvert leur blog en direct dans un navigateur Internet, n'en n'ont pas besoin.

MAX_ENTRIES

Par défaut le nombre est à 10, qui est le nombre d'entrées analysées par requête. Vous pouvez sans crainte pousser à plusieurs centaines être sûr pour que la totalité des entrées soient analysées. La question est de savoir à combien de mois ou d'années vous désirez remonter. Cette variable ne concerne que les entrées (les billets), pas les articles. En cas de pagination multiple (si l'on active MAX-MAINPAGE-ENTRIES) ce sera le nombre maximal d'entrées qui sera prise en compte. En supposant que vous ayez mis MAX-ENTRIES à 100 alors que vous avez 130 billets en archive, seul les 100 billets les plus récents seront pris en compte, tant pour les requêtes que les paginations (si vous avez mis MAX-MAINPAGE-ENTRIES à "5", il sera généré 20 pages index principales). Mais cette valeur peut être surpassée par MAINPAGE-QUERY en cas de pagination multiple des entrées principales du blog.

DATE_FORMAT

Cette variable n'est pas indispensable si votre système est déjà configuré à votre goût. Dans ce cas elle invoquera la commande date par défaut de votre machine. C'est elle qui formatera la date de vos billet et qui apparaîtra en gros sur votre page d'accueil ! Mais le plus souvent il faudra apporter un correctif, d'où l'utilité de cette variable. Il vous faudra malheureusement vous plonger dans la page de man de date, en entrant :

man date

Attention à certains pièges : comme une configuration différente entre le compte root et les comptes user... Vous pouvez avoir le désir d'avoir un format de date spécifique à la nationalité des lecteurs potentiels de votre blog. Vous pouvez aussi ne pas révéler à quelle seconde votre blog a été mis à jour, et juste la date et pas l'heure peut vous importer. Donc un réglage important, parfois délicat : la page de man est votre amie.

DATE_LOCALE

Dans LOCALE il faut entendre linguistique. Normalement, elle elle laissée en blanc car la variable $LANG est prise en compte automatiquement. Mais vous pouvez vouloir avoir un autre paramètre linguistique, selon votre lectorat potentiel.

DATE_ARGS

Voir plus haut à DATE_FORMAT

BLOG_URL

Cette variable doit être absolument renseignée si vous prenez l'option d'avoir les liens en chemin absolu (c-a-d l'URL complète). Si vous voulez avoir les flux de syndication comme ATOM ou RSS, vous devez mettre les chemins en absolu. Donc mettre l'adresse de votre blog tel qu'il sera vu de l'extérieur. Supposons que vous avez le serveur Web Apache et que votre blog se situe dans /home/toto/public_html, il sera vu de l'extérieur sous l'adresse :http://www.tartempion.fr. C'est cette adresse qu'il vous faudra mettre à cette variable. Attention de ne pas mettre de barre de fraction à la fin de l'adresse !

BLOG_CSS

Cette variable vous permet de faire le choix d'une des feuilles de style présentes dans le répertoire styles. Mais vous pouvez très bien en modifier une ou même en créer une nouvelle que vous aurez nommée autrement. L'adresse devrait toujours être en chemin relatif. Mais si vous aviez une feuille de style hébergée sur un autre site que le votre, il faudra inclure manuellement cette adresse externe dans les templates formatant les pages.

BLOG_ICON

Pareil que pour les feuilles de style; cette variable donne l'adresse relative du fichier de l'icône qui apparaîtra à gauche de l'URL de votre site dans la barre d'adresse des navigateurs Internet.

BLOGURLACTION

Cette variable n'est pas pour les débutants ! Elle sert activer des fonctionnalités qui ne sont pas en standard dans le logiciel, comme les extensions en script CGI. À ce niveau de connaissance, la lecture de ce Wiki est superflue...

BLOG_CHARSET

Spécifie l'encodage du blog. Sauf si vous savez ce que vous faites, laissez la valeur par défaut à utf-8.

BLOG_MIMETYPE

Spécifie le type MIME du blog. Si vous ne savez pas ce qu'est un type MIME, vous avez intérêt à ne pas toucher la valeur par défaut. De toute façon, cette valeur par défaut est celle qui est la plus banale. La modifier n'a d'intérêt que si le blog fait autre chose que du texte ou qu'il apparaît nécessaire d'apparier cette valeur à celle envoyée par le serveur Web. Pour spécialiste seulement !

BLOG_TZD

Indique le fuseau horaire. Cette variable est à travailler en même temps que DATEFORMAT, DATELOCALE et DATE_ARGS. Cette variable peut-être laissée en blanc si votre système indique le fuseau horaire avec la commande date.

BLOG_TITLE

LA variable à mettre en priorité ! C'est tout bonnement le titre de votre blog. Attention à bien le choisir, car ce sera aussi celui qui apparaîtra dans la barre de titre sur le cadre de la fenêtres des navigateurs. C'est aussi celui qui sera référencé par les moteurs de recherche (ne pas en changer toutes les semaines). Si l'on vise l'international, tenir compte aussi des difficultés à gérer les caractères franco-français...

BLOG_DESCRIPTION

C'est le sous-titre de votre blog. Par défaut, la feuille de style met tous les caractères en minuscule. Il vaut mieux saisir ce sous-titre avec la (ls) majuscule(s) au bon endroit, car les moteurs de recherche ne tiennent pas compte du style, et mieux vaut être référencer correctement.

BLOG_AUTHOR

C'est l'endroit où mettre votre nom ! Il apparaîtra par défaut dans les billets que vous éditerez. Vous n'êtes pas obligé d'en mettre un; auquel cas il vous le sera demandé à chaque édition de billet. Mais même si vous en mettez un, il vous sera possible d'en préciser un autre lors de l'édition d'un billet. c'est juste une question de confort et n'influe pas sur l'apparence de la page Web.

BLOG_CONTACT

C'est là qu'il faut mettre à la fois son titre et son adresse e-mail. Tenir compte que toutes ces variables obéissent aux lois du scripting BASH et de ce fait lorsqu'on joue avec les apostrophes simple et les guillemets anglais, on peut s'estimer heureux de ne pas trop se planter. Pour le site de ?NanoBlogger francophone on a :

BLOG_CONTACT="Pour la traduction, les billets et les thèmes : (balise br/)
(balise a) + href=\"mailto:deber@users.sourceforge.net\">Denis Bernard (balise /a)(balise br/)
Pour le wiki :(balise br/)
(balise a) href=\"mailto:olivier@dossmann.net\">Olivier Dossmann (balise /a)"

Divers

BLOGPREVIEWCMD

C'est la commande qui lancera le navigateur Internet choisi dans NB_BROWSER. Vous pouvez laisser l'instruction par défaut si votre blog a bien sa page d'entrée sous l'appellation index.html .

BLOGPUBLISHCMD

Écrire ici la commande qui permettra de uploader vos pages vers le serveur. Vous pouvez laisser cette option vide si votre répertoire de blog est déjà dans celui du serveur web ! Ou bien si vous préférez faire les transferts manuellement en FTP ou autre. Mais à la longue la synchronisation entre votre répertoire local et celui distant nécessitera une automatisation des tâches. D'où l'intérêt de cette commande... A FAIRE : une notice séparée dans ce wiki, sur l'art et la manière de faire les synchronisations entre répertoires.

BLOG_INTERACTIVE

Par défaut mis à "0", c'est à dire pas d'interactivité. Mettre cette option à "1", activera le mode conversationnel au cours de l'édition des pages. Ça améliore grandement le confort ! Mais ne pas le mettre si NB est appelé par une tâche périodique (pour une mise à jour par ex. avec cron) ce qui gèlera le processus...

SHOW_TIMES

Vous pouvez laisser cette option à "0" s'il vous importe peu de connaître le temps de traitement de l'élaboration des pages de votre blog. Sinon, mettre "1"; sous pouvez lire la page de man times pour en savoir plus. Cette option n'allonge pas le temps de traitement.

QUERY_MODE

Par défaut mis égal à MAX (voir MAX_ENTRIES ci-dessus). Cette valeur sera celle qui déterminera le nombres d'entrées (en commençant par la plus récente) à analyser dans le cas d'une recherche (d'un mot-clé par ex.) ou du management des entrées. Ce n'est pas un nombre, les autres options possibles sont : all|tag|DATE|main.

Préférences pour les liens

SHOW_INDEXFILE

Par défaut mis à "1": ça consiste à mettre l'URL complète finissant par index.html . Dans le cas contraire, l'URL ne comportera que le nom du dossier qui contient index.html .

SHOW_PERMALINKS

Par défaut mis à "1" : ça permet de mettre le lien de l'article dans permalien. Dans le cas contraire, le permalien n'apparaît pas dans l'entrée; mais l'entrée est bien archivée et donc chaque entrée est lisible individuellement par navigation dans les archives.

SHOW_CATLINKS

Par défaut mis à "1" : ça permet de faire apparaître le lien de(s) la catégorie(s) dans l'entrée. Dans le cas contraire ce lien n'apparaîtra pas, mais les catégories seront toujours mentionnées dans la colonne des leins et dans les archives.

FRIENDLY_LINKS

Par défaut mis à "1" : ça consiste à nommer les liens en se servant du titre de l'entrée pour nommer les fichiers html. Dans le cas contraire, les liens prennent le nom initial du fichier texte sous la forme de date. Le but est de rendre plus convivial le l'intitulé des fichiers pour un humain. Les inconvénients sont :

grande longueur du nom de fichier
si le système de fichier n'est pas sous utf-8, les signes diacritiques (accents,etc.)seront perturbateurs.

MAX_TITLEWIDTH

Par défaut mis à 150 caractères. C'est la taille qui limitera la longueur du titre dans le cas où l'option FRIENDLY-LINKS est mise à "1". Il n'y a pas d'inconvénient à le laisser tel quel si l'on active pas l'option FRIENDLY-LINKS .

ABSOLUTE_LINKS

N'est pas activé par défaut. Dans le cas contraire, les liens sont rédigés avec leur URL complète (comme http://www.monblog.com/index.html). Il faut pour cela que BLOG_URL soit renseigné. Cette option doit être activée si l'on veut avoir les flux de syndication !

Plugins

PLUGINS-DIR

Par défaut laissé en blanc (auto-complétion par le logiciel). C'est le répertoire qui contient les plugins si celui par défaut n'est pas choisi. Attention, il s'agit des plugins communs à tout les blogs !

USR-PLUGINSDIR

ENTRY_EXCERPTS

Cette variable est destinée à donner un extrait de l'entrée dans la page principale, qui pourra être lu en entier après avoir cliqué sur le lien "read more...". L'emplacement de la coupure devrait se faire après soit la première ligne vide (2 retours chariot consécutifs) ou bien après la balise XML "!--more--" (voir le fichier "/plugins/entry/z001-excerpt.sh"). Cette facilité ne semble pas être activée dans la version 3.4RC2 . On peut le faire manuellement par modification du template "entry.html" en substituant la ligne contenant "$NBEntryBody" par "$NBEntryExcerpt".

ENTRY_FORMAT

Met le format par défaut des entrées. Normalement à "raw", c'est à dire que vous avez préalablement formaté le texte avec des balises HTML. À noter que si vous entrez directement le texte sans aucune balise, la page sera sera quand même valide car le texte sera inclus à l'intérieur d'une division. Vous pouvez choisir une autre forme de format comme "autobr" ou "markdown. C'est bien utile si vous importez des billets précédemment écrits sous un autre format que HTML.

PAGE_FORMAT

Même chose que ENTRY-FORMAT en ce qui concerne des pages autres que les entrées.

MAX_YEARLINKS

Nombre maximun des liens pour une année. Par défaut à "12". Normalement on n'a pas besoin de mettre autre chose.

MAX_MONTHLINKS

Nombre maximun des liens pour un mois. Par défaut à "12". Normalement on n'a pas besoin de mettre autre chose.

CAL_ARGS

C'est l'option à ajouter à l'utilitaire "cal" qui fabrique le calendrier (voir la page de "man cal"). Dans la tradition française, les calendriers font débuter la semaine par le lundi contrairement au monde anglo-saxon. Dans ce cas l'option "-m" est tout indiquée pour nous...

TIDY-CMD, TIDY-HTML-ARGS et TIDY-XML-ARGS

Il y a trois options pour l'utilitaire Tidy. Les options par défaut semblent fonctionner correctement. À noter que l'utilitaire "Tidy" doit être installé sur votre système. Et même si vous l'avez, vous pouvez choisir de ne pas l'activer : voir ce que dit le manuel à ce propos, sur les inconvénients possibles. Ce qui est sûr, c'est que le code source généré fera apparaître qu'il a été généré par Tidy. Vous pouvez, si vous maîtrisez bien le HTML et que vous validez manuellement votre code avec le site en ligne "http://validator.w3.org/", vous passer de "Tidy".

MARKDOWN-CMD et MARKDOWN-OPTS

Il y a deux options pour activer Markdown. Enlever le dièse qui les précède pour les activer, après avoir vérifié si vous avez bien Markdown d'installé sur votre système et que les chemins sont corrects.

NB : Tel que donné dans le fichier de configuration de Nanoblogger 3.4RC2, markdown utilise python, veillez à installer python, markdown, et si besoin python-markdown. Sous Debian une simple commande suffit (lancée en tant que root) :

apt-get install python markdown python-markdown

Et cela devrait fonctionner.

Un utilisateur de Nanoblogger donne plus de détails sur sa démarche dans un article de Brain Log intitulé Nanoblogger notes setup.

Si vous voulez corriger le souci de markdown tel qu'il le décrit, pensez aussi à modifier le script plugins/pages/format/markdown.sh en remplaçant les lignes par :

nb_msg "$plugins_entryfilteraction `basename $nb_plugin` ..."
MKPAGE_CONTENT=`echo "$MKPAGE_CONTENT" | ${MARKDOWN_CMD} ${MARKDOWN_OPTS}`

Ceci devrait vous permettre de rédiger vos articles au format MARKDOWN.

FORTUNE-CMD et FORTUNE-FILE

Enlever les dièses pour activer la publication des "mot du jour" (fortune); et bien sûr mettre la commande exacte (voir les options dans la page "man fortune") et le nom du fichier.

Syndication

BLOG-FEED_URL

Mettre ici l'URL véritable de votre site tel qu'il sera vu de l'extérieur (chemin absolu). Pensez aussi à mettre en chemin absolu vos autres fichiers par la variable BLOG_URL .

BLOG-FEED-TZD

Mettre ici le fuseau horaire de vos flux de syndication. Par défaut ce sera celui défini à BLOG_TZD.

BLOG-FEED-LANG

Mettre ici le code pays de votre langue. Pour nous ce devrait être "fr-fr".

ATOM-FEED-LANG

Mettre ici la langue pour les flux ATOM. Pour nous ce devrait être "fr".

BLOG-FEED-CSS

Le chemin (relatif) vers la feuille de style spécifique aux flux. Pour l'instant, la feuille standard donne satisfaction, mais rien ne vous empêche d'en mettre ou d'en créer une autre !

BLOG-FEED-LOGO

Le chemin (relatif) vers le logo pour les flux de syndication.

BLOG-FEED-ICON

Le chemin (relatif) pour les icônes de flux. Seul RSS2 semble le supporter.

CATEGORY-FEEDS

Quand mis à "1", les flux de syndication catégorie par catégorie sont générés.

ATOM-CATFEEDS

Quand mis à "1", les flux de syndication ATOM catégorie par catégorie sont générés.

RSS2-CATFEEDS

Quand mis à "1", les flux de syndication RSS 2.0 catégorie par catégorie sont générés.

RSS-CATFEEDS

Quand mis à "1", les flux de syndication RSS 1.0 catégorie par catégorie sont générés.

Articles

ARTICLES_DIR

Par défaut mis à "articles". Vous pouvez très bien avoir des articles dans plusieurs répertoires. vous devez donc les citer (chemin relatif) comme ceci si vous avez trois répertoires nommés respectivement :articles, articles/howtos et notes :

ARTICLES_DIR="articles articles/howtos notes"

Les répertoires doivent déjà exister. Dans cet exemple, trois sections seront créées qui prendront le nom du répertoire. Vous pouvez ajouter un fichier texte qui doit être précédé d'un point qui contiendra un autre nom de section :".articles_title.txt" .

ARTICLES_FORMAT

Format à spécifier pour les articles (comme "raw" ou "markdown"). Par défaut celui qui est déjà défini à PAGE_FORMAT. Mettre le chemin relatif complet comme :"plugins/page/format/markdown.sh".

Cache

MAX-CACHE-ENTRIES

Il y a différentes valeurs proposées ici. Celle qui est mise par défaut semble donner satisfaction. Le rôle du cache est bien utile pour raccourcir considérablement le temps de traitement en évitant au logiciel de fabriquer à nouveau inutilement les pages qui n'ont pas besoin d'être corrigées. Mais ne pas oublier en cas d'insertion manuelle d'une entrée en ne passant pas par l'éditeur appelé par NB, de forcer le rafraîchissement du cache par la commande "update-cache all" ou son synonyme :"--force". Dans tous les cas où l'on a un doute, provoquer le rafraîchissement du cache. On gagne du temps aussi sur le traitement en faisant un "update" avec les options comme "articles, tag ou main". Ainsi le rafraîchissemnt d'une entrée où l'on vient de corriger une faute d'orthographe sera avantageusement faite avec "nb -u main" au lieu de "nb -u".

BLOG-CACHEMNG

Par défaut en automatique. Ça semble être la bonne option.

Sécurité

NB-TEMP-DIR

Spécification du répertoire temporaire. Dans un environnement multi-utilisateurs, les données dans les répertoires temporaires sont des failles de sécurité potentielles. Vous pouvez en spécifier un autre de votre choix.

NB-UMASK

Spécifie la commande UMASK (voir les pages de man) pour les fichiers nouvellement créés par le blog. Par défaut le masque appliqué est celui de l'usager courant.