Documentation du Dr FRAPPE

Ce wiki regroupe les résultats de mes expériences en informatique accumulés au cours de mes recherches sur le net.

Dans la mesure du possible, j'ai cité mes sources ; il en manque certainement… :-)

odt : Export OpenOffice.org/LibreOffice.org

Pré-requis

  • PHP

Installation

Configuration

La version actuelle dispose des options de configuration suivantes :

Nom de l'option Fonction
tpl_dir Sous-répertoire des modèles dans le gestionnaire de médias.
Téléchargez vos fichiers de modèle ODT dans ce répertoire.
odt_template Fichier ODT à utiliser comme modèle.
Par défaut, ce champ est vide. Dans ce cas, des styles par défaut sont utilisés.
Le modèle peut également être un fichier CSS.
Assurez-vous d'utiliser les extensions de fichier correctes (.odt ou .css) afin que le plugin puisse différer entre les types de fichiers.
showexportbutton Afficher le bouton d'exportation ODT ?
showpdfexportbutton Afficher le bouton d'exportation PDF? (exportation en ODT et conversion en PDF)
css_usage Ce paramètre spécifie de quelle manière le code CSS importé du 'css_template' est utilisé.
S'il est défini sur off (plugins uniquement) (par défaut), le code CSS n'influencera que la sortie ODT des plugins.
S'il est défini sur l'importation de style de base, le plug-in ODT appliquera en outre le code CSS importé sur les styles de base comme la mise en forme de texte de base, les en-têtes, les listes et les tableaux.
media_sel Quel sélecteur @media doit être utilisé pour interroger les propriétés CSS ?
Par exemple, «print» ou «screen».
Actuellement, cela n'affecte que l'exportation ODT des plugins, par exemple le plugin wrap.
css_font_size Taille de police de base pour l'importation / la gestion CSS. Il s'agit de la valeur initiale représentant 1em.
css_template modèle DokuWiki à utiliser pour l'importation CSS. Cela n'affecte que le contenu CSS donné aux plugins. Cela n'affecte pas l'apparence de la syntaxe de base de DokuWiki.
apply_fs_to_non_css S'il est défini sur true, css_font_size sera également appliqué si un modèle ODT est utilisé ou si aucun modèle n'est utilisé (pas de CSS ni de modèle ODT [par défaut]).
twips_per_pixel_x Twips par pixel sur l'axe X
twips_per_pixel_y Twips par pixel sur l'axe Y.
format Format de page du document exporté.
Formats pris en charge :
A6, A5, A4, A3, B6 (ISO), B5 (ISO), B4 (ISO),
Letter, Legal, Long Bond, Tabloid,
B6 (JIS), B5 (JIS), B4 (JIS), 16 Kai, 32 Quay, Big 32 Quay,
DL Envelope, C6 Envelope, C6 / 5 Envelope, C5 Envelope, C4 Envelope, #6 3/4 Envelope, #7 3/4 (Monarch) Envelope,
#9 Envelope, #10 Envelope, #11 Enveloppe, #12 enveloppe, carte postale japonaise.
orientation Orientation du document exporté ( 'portrait' ou 'landscape').
margin Top, Right, Bottom, Left Marges pour le document exporté en centimètres.
disable_links Si «Yes», les liens ne seront pas codés en tant que liens mais simplement en texte brut.
toc_maxlevel Profondeur maximale pour la table des matières.
Si vide, la valeur de l'option globale DokuWiki «maxtoclevel» est utilisée.
toc_leader_sign signe de tête à insérer dans la table des matières.
toc_indents Indentation de la table des matières par niveau.
Valeurs absolues en centimètres, non relatives au niveau précédent.
Par exemple. le réglage «0, 0,5, 1, 1,5, 2, 2,5, 3, 3,5, 4, 4,5» conduit à une identification de 0,5 cm de plus par niveau.
Alors que '0, 1, 1, 1, 1, 1, 1, 1, 1, 1' maintient le niveau 1 non indenté et tous les autres niveaux ont la même indentation de 1 centimètre
toc_pagebreak Insérer un saut de page après la table des matières ?
toc_style Style à utiliser pour la table des matières au format CSS, par exemple: 'color:red;'
Chaque niveau utilise le même style par défaut.
Vous pouvez attribuer des styles spécifiques à l'aide de la balise syntax
index_in_browser Si mis à hide, la balise de syntaxe toc et l'index de chapitre ne créeront aucune sortie visible dans le navigateur.
S'il est configuré à display placeholder, un petit paragraphe d'espace réservé sera affiché dans le navigateur, indiquant à l'utilisateur que la balise de syntaxe est là et une table des matières ou un index de chapitre sera inséré lors de l'exportation vers ODT.
outline_list_style - S'il est défini sur Normal, les titres n'auront pas de style de liste après l'exportation.
- S'il est défini sur Numbers, tous les en-têtes seront numérotés après l'exportation vers ODT.
Attention: les numéros des titres n'apparaîtront dans la table des matières ou l'index des chapitres qu'après leur mise à jour (ce qui est de toute façon obligatoire).
olist_label_align spécifie comment aligner les nombres devant les éléments de liste dans une liste ordonnée (left, center, right [default])
convert_to_pdf Ligne de commande à exécuter pour la conversion ODT en PDF.
La valeur par défaut spécifie la ligne de commande pour la conversion PDF à l'aide de LibreOffice.

Balises de syntaxe supplémentaires

Des balises de syntaxe pour des fonctionnalités supplémentaires ne peuvent pas être définies uniquement dans la configuration, car, par exemple, dépendant de la position.

pagebreak
Un saut de page manuel peut être inséré en ajoutant la balise de syntaxe <pagebreak> dans la page wiki. Cette fonctionnalité nécessite le plugin Pagebreak.
page
La balise de syntaxe page peut définir le format de page, l'orientation et les marges avec une seule commande.
Le format est le suivant :
{{odt>page:format,orientation,margin_top,margin_right,margin_bottom,margin_left}}
L'exemple suivant définit le format de page A3, l'orientation paysage et toutes les marges sur 1 centimètre :
{{odt>page:A3,landscape,1,1,1,1}}
Vous pouvez également omettre des paramètres que vous ne souhaitez pas modifier, par exemple :
{{odt>page:A3,landscape}}

Cela change le format et l'orientation de la page, mais pas les marges.

Si vous souhaitez modifier une seule propriété de page, vous pouvez utiliser les balises de paramètres pour le format, l'orientation ou les marges uniquement. Voir quelques exemples ci-dessous :
{{odt>format:A3}}
{{odt>format:A4}}

{{odt>orientation:portrait}}
{{odt>orientation:landscape}}

{{odt>margin_top:1}}
{{odt>margin_right:2}}
{{odt>margin_left:3}}
{{odt>margin_bottom:4}}
Un changement de format de page terminera la page en cours, provoquera un saut de page et la page suivante utilisera alors le format de page nouvellement défini.
toc
La balise de syntaxe toc peut être utilisée pour insérer une table des matières à la position de la balise.
Sans insertion de la balise de syntaxe toc, aucune table des matières ne sera créée du tout.
La syntaxe minimale est:
{{odt>toc}}

Cela créera une table des matières avec tous les paramètres pertinents tirés de la configuration du plug-in ODT. Le titre sera «Table des matières» (selon la langue choisie).

Les options suivantes pour la balise de syntaxe toc existent :
  • maxlevel : remplace toc_maxlevel
  • title : remplace le titre par défaut spécifique à la langue «Table des matières»
  • leader_sign : remplace toc_leader_sign
  • indents : remplace toc_indents
  • pagebreak : remplace toc_pagebreak
  • styleH : remplace le style d'en-tête du contenu dans le fichier styles.xml
  • styleL1 … styleLN: N = maxlevel, remplace toc_style
Ceux-ci ont tous la même signification que les paramètres de configuration correspondants.
La seule exception est styleL1 … styleLN.
Le paramètre de configuration toc_style définit le style de l'ensemble de la table des matières.
styleL1 définit uniquement le style pour le niveau 1 du toc, styleL2 définit uniquement le style pour le niveau 2 du toc…
L'option syntaxH fonctionne de la même manière que l'option style ci-dessus, mais pour l'en-tête de la table des matières.
Toutes ces options sont facultatives.
Si vous en omettez une, le paramètre correspondant de la configuration (ou paramètre de demande d'URL) sera utilisé.
Chaque option doit être terminée avec un ;
Voici quelques exemples (tous sur une ligne):
{{odt>toc:title=Content;leader_sign=.;indents=0,0.5,1;pagebreak=true;
styleL1="font-weight:bold;";styleL2="font-style:italic;";
styleL3="font-style:normal;";}}
{{odt>toc:title=Content;leader_sign=_;indents=0,2,2;pagebreak=false;
styleL1="font-weight:bold;";styleL2="font-style:normal;";
styleL3="font-style:normal;";}}
chapter-index
La balise de syntaxe chapter-index peut être utilisée pour insérer un index de chapitre à la position de la balise.
Sans insérer la balise de syntaxe chapter-index, aucun index de chapitre ne sera créé du tout.
La syntaxe minimale est :
{{odt>chapter-index}}

Cela créera un index de chapitre avec tous les paramètres pertinents tirés de la configuration du plug-in ODT pour la table des matières.

Par défaut, l'index de chapitre n'aura pas de titre.
Les options de la balise de syntaxe chapitre-index sont les mêmes que pour la balise de syntaxe toc.
disablelinks/enablelinks
Ces balises activent ou désactivent la création de liens, tout comme le paramètre de configuration.
Voici la syntaxe :
{{odt>disablelinks}}
{{odt>enablelinks}}
templatepage
Cette balise peut être utilisée pour spécifier une page wiki comme modèle CSS.
Cela signifie que tout le contenu de la page est importé en tant que code CSS.
Exemple :
{{odt>templatepage:mycsspage}}
Il est tout à fait correct que le code CSS dans la page de modèle soit entouré de balises

pour améliorer la lisibilité.

Cette fonctionnalité permet à l'utilisateur d'utiliser un modèle CSS sans avoir à télécharger de fichiers.

ATTENTION: l'utilisation d'une page de modèle peut remplacer les paramètres de style déjà importés d'un fichier de modèle ODT ou CSS.

frame-open/frame-close
Ces balises insèrent le contenu entre elles dans un cadre ODT lors de l'exportation vers ODT.
La vue HTML n'est pas modifiée.
Voici la syntaxe :
{{odt>frame-open:...options...}}
{{odt>frame-close}}
Mettre du contenu dans un cadre peut par exemple être utilisé pour positionner ce contenu sur un point fixe de la page.
C'est par exemple peut être utile pour écrire des lettres.

Utilisation

Pour rendre une seule page exportable, vous pouvez ajouter la macro suivante à la page:

~~ODT~~

Une meilleure façon consiste à intégrer un bouton d'exportation dans votre modèle.

Si vous utilisez le modèle par défaut, activez simplement le bouton dans le menu de configuration.

Sinon, utilisez ce qui suit pour ajouter un autre bouton dans la rangée de boutons supérieure ou inférieure du modèle1)

<form class="button" method="get" action="<?php wl($ID)?>">
    <div class="no">
        <input type="submit" value="Export to ODT" class="button" />
        <input type="hidden" name="do" value="export_odt" />
        <input type="hidden" name="id" value="<?php echo $ID?>" />
    </div>
</form>

Ou utilisez ceci pour une simple icône 16 x 16 quelque part dans votre modèle :

<a href="<?php echo exportlink($ID, 'odt')?>"><img src="<?php echo DOKU_BASE?>lib/images/fileicons/odt.png" alt="ODT Export" /></a>

Vous pouvez mélanger les 2 méthodes précédentes, et obtenir un bouton avec une image à l'intérieur, avec ce code:

<form class="button" method="get" action="<?php wl($ID)?>">
    <div class="no">
        <button type="submit" class="button">
            <img src="<?php echo DOKU_BASE?>lib/images/fileicons/odt.png" alt="ODT Export" />
           Export to ODT
        </button>
        <input type="hidden" name="do" value="export_odt" />
        <input type="hidden" name="rev" value="<?php global $REV; echo $REV?>" />
        <input type="hidden" name="id" value="<?php echo $ID?>" />
    </div>
</form>

Réglages

La plupart des paramètres ou options de configuration peuvent être définis dans la configuration du plug-in ODT, en transmettant le paramètre comme paramètre de demande d'URL ou en utilisant la balise de syntaxe.

La priorité est la suivante (la première entrée a la priorité la plus élevée, la dernière entrée a la plus faible):

  1. tag syntax
  2. Paramètre de demande d'URL
  3. Paramètre de configuration du plug-in ODT
  4. Paramètre de configuration DokuWiki
    (ne concerne que 'toc_maxlevel', voir la section Configuration)

Voici un exemple pour passer l'orientation du paramètre en tant que paramètre de demande d'URL: https://www.dokuwiki.org/plugin:odt?orientation=landscape&do=export_odt

La même chose fonctionne pour les balises de syntaxe. Les balises de syntaxe des paramètres ont toujours le même format :

{{odt>setting:value}}

Voici à nouveau l’exemple du réglage de l'orientation :

{{odt>orientation:landscape}}

Désinstallation

Voir aussi


Basé sur « OpenOffice.org/LibreOffice.org Export » par Andreas Gohr, Aurélien Bompard, Florian Lamml, Lars (LarsDW223).