Mise à jour du site de doc

[chamalo]

Donc quelque petit Truc avec Asciidoctor

Asciidoctor gère très bien les images, il mets automatiquement une image inline(image:) à la taille de la ligne
Si on veut comme je le fait avoir sont texte à cote de son image :

Code : Tout sélectionner

image:monimage.png[role="related thumb left"] Mon Texte

Asciidoctor gére très bien les retour de lignes, si vous voulez faire comme moi et mettre vos image+texte dans des blocks, il faut rajouter un nombre de

Code : Tout sélectionner

{nbsp} +

suffisant pour agrandir votre block

pour les icons, plus besoin de rajouter les icons dans vos images, utliser la font Awesome:

Code : Tout sélectionner

:icons: font

pour l'encodage vous pouvez rajouter ces lignes :

Code : Tout sélectionner

:lang: fr
:encoding: utf-8

Pour faire un tableau avec entête, et taille des colonnes en auto - NB: AsciiDoctor peut géré que 10 colonne, contrairement à 12 avec Bootstrap:

Code : Tout sélectionner

[options="header,autowidth",role="text-justify"]
|===
|Action |Description

|image:cadres.png[role="related thumb left"]
|Permet d'accéder à la gestion des pages secondaires qui sera traitée ....
|===

Y'a un log fail2ban dans /var/log de mémoire tu as quoi dedans ?

le fichier est vide

[loic]

Sinon faut le lancer en manuel type fail2ban peut être en commande

[chamalo]

Sinon faut le lancer en manuel type fail2ban peut être en commande

pas trop grave dans mon cas j'ai fermé tout les ports suis tranquille pour l'instant, si je veut accéder de l'extérieur je passe par le market

sinon pour en revenir à la doc, je sais que je t'en ai déjà parlé, mais avec AsciiDoctor cela devient plus simple à installer,
Peut tu rajouter Pygments au serveur de doc :

Code : Tout sélectionner

 apt-get install -y pygments.rb

Sans Pygments:

codesanspygments.png (12.96 Kio) Consulté 2160 fois

Avec Pygments

codepygments.png (8.18 Kio) Consulté 2160 fois

au niveau des fichiers Asciidoc il suffit de rajouter sur le premier

Code : Tout sélectionner

:source-highlighter: pygments
:pygments-style: borland

le deuxième champs étant le style utilisé, ils sont tous présent par défaut suffit juste de choisir, on peut faire des tests sur leur site pour choisir

[loic]

J'aimerais bien mais non en faite la le changement c'est pour que ca tourne sur un mutualisé OVH donc je peux rien installer...

[SBO]

@loic @chamalo

A votre avis, avec le module Asscidoctor Preview de Chrome, dans la configuration avancé, quelle paramètre vous spécifier ?

Ma conf :
Custom attributes : -b bootstrap -a numbered -a responsive-option -a navbar=fixed -a jumbotron-fullwidth -a toc2 -a footer-fullwidth -a toclevels=1 -a tocaffix

Safe mode : Server

Theme / Stylesheet : asciidoctor

JavaScript : "vide"

La mise en forme est presque conforme, par contre je n'ai pas le sommaire sur la gauche, mais un espace vide.

Une idée ?

[loic]

J'arrive pas non plus a avoir le sommaire c'est comme si il ne prenait pas l'option

[SBO]

J'arrive pas non plus a avoir le sommaire c'est comme si il ne prenait pas l'option

Dans la doc du module :

Code : Tout sélectionner

TOC

It’s important to note that since the Chrome extension converts the document to embeddable HTML (header and footer disabled), the only TOC placement that work are preamble (if the document has a preamble) or manual placement.

toc-preambule.adoc
= Title
:toc: preamble
toc-manual-placement.adoc
= Title
:toc:
:toc-placement!:

Somewhere...
toc::[]
You can also use preprocessor directives to fine-tune the content to put the TOC in the right place depending on the environment.

Si je comprends bien, seul le sommaire dans le contenu du doc est faisable.

[chamalo]

j'ai installé asciiDoctor sur ma Jeedomboard du coup je test en local avec les paramètres de loic

[SBO]

@loic

Pour avoir la preview j'ai changé la conf :

Code : Tout sélectionner

 -b bootstrap -a numbered -a responsive-option -a navbar=fixed -a jumbotron-fullwidth -a footer-fullwidth -a toclevels=4

J'ai viré : -a toc2 -a tocaffix

tocaffix : semble être un attribut uniquement du bootstap de laurent laville

Dans le doc j'ai ajouté :

Code : Tout sélectionner

:toc: macro
:toc-placement: preamble

Par contre si on publie comme cela nos doc, on risque d'avoir deux sommaires, 1 dans le doc et l'autre sur la gauche. Sauf si lors de la génération il force la position à gauche.

Je vais poster la doc datatransfert avec cette modification pour voir ce que cela génère.
Dis moi quand c'est validé pour regarder le rendu.

[SBO]

j'ai installé asciiDoctor sur ma Jeedomboard du coup je test en local avec les paramètres de loic

Mais faut pencher la tête comme pour regarder la TV

[SBO]

Dans le changelog d'asciidoc :

Code : Tout sélectionner

deprecate toc2 attribute in favor of position and placement values on toc attribute (e.g., toc=left) (#706)

Par contre j'ai essayé le "-a toc=left" cela ne fonctionne pas mieux

[Darkeyes]

Bonjour,

Petite question.

Est-il prévu de pourvoir faire des docs pour les scripts du plugin script.
Car actuellement pour un de mes scripts , la doc ce trouve dans un sujet du forum.

Quel est votre démarche par rapport a ça?

[loic]

Bonjour,

Non pour l'instant rien de prévu j'ai peur que le site de doc devient trop complexe ensuite ou alors un depot avec plein de doc un pour les widget un pour les scripts, mais faudra que vous fassiez des pull request

[SBO]

Bonjour,

Non pour l'instant rien de prévu j'ai peur que le site de doc devient trop complexe ensuite ou alors un depot avec plein de doc un pour les widget un pour les scripts, mais faudra que vous fassiez des pull request

Loic

c'est clair que pour les widgets et scripts c'est pas aussi simple.

Le problème c'est qu'il n'est pas possible d'avoir un document chapeau car le include:: ne permet pas de mettre de wilcards (include::configuration.widget.*).

Sinon un dépot a part pourquoi pas, mais cela fait une gestion en plus.

Au final, par contre la doc de widgets et scripts serait un plus car nécessite des recherches importantes sur le fofo.

Si tu trouves une idée géniale Loic, je pourrais voir pour faire un modèle de doc pour widgets et script. Mais rien de compliqué de ce côté là.

[loic]

Pour moi un depot a part et je fais comme pour les module zwave ou autre

[SBO]

Pour moi un depot a part et je fais comme pour les module zwave ou autre

C'est certain que c'est faisable, mais c'est l'exploitation qui risque d'être pénible pour toi à devoir valider chaque comit.

[loic]

Oui ca risque d'etre pénible mais pour l'instant j'ai rien de mieux....

[totovaauski]

Et le wiki?

Envoyer avec mon pouce ...

[Anonyme]

Contenu supprimé à la demande de son auteur

[chamalo]

il y a une méthode plu simple, loic, un post-it Trucs et Astuces, ou Index des Scripts/Widgets avec des liens qui pointent vers les liens des auteurs, après suffit de tenir à jour la liste