B-Basic.net

Innovation Informatique France

Documentations

La documentation d'un logiciel B-Basic, fais appel a la classe AUTODOC du langage. Cette classe met a votre disposition un système d'aide embarqué.

Editeur_de_doc.jpg

Editeur une documentation

La documentation d'un logiciel B-Basic est un fichier Doc.rtf dans lequel la fonction G de la classe AUTODOC, identifie les paragraphes par la balise, placée en début de ligne, suivie du titre et finalisé par le symbole ":"

    [doc]TITRE DE PARAGRAPHE :

    Texte et image

    [doc]FIN DE PROGRAMME :

    Texte et images.

    [doc]LECTEUR EN DUO :

    Texte et images

Nous obtenons ici 3 chapitres, pouvant êtres affichés indépendamment dans l'interface de visualisation.

 

Le répertoire RLA

La documentation d'un logiciel B-Basic est un fichier Doc.rtf, stocké en racine du répertoire RLA du logiciel, et exploité par la classe AUTODOC du langage B-Basic. Le fichier Doc.rtf, est un fichier RTF classique dans lequel sous pouvez insérer des images et etc.

 

La balise DOC

La classe AUTODOC, réunie les fonctions nécéssaires a la création et la gestion d'une interface de visualisation de documentation. Si cela vous semble déja compliqué, voici le code source nécessaire a la mise en place d'un système de documentation d'un logiciel B-Basic

!
!    -- Fenetre Autodoc et Création des chapitres
!
    AUTODOC(A,94,90,lg-35,ht-35)
    AUTODOC(G,V1)
    affdoc=0

Explication du code. La fonction A de la classe autodoc, définie l'interface de visualisation. La fonction G, identifie les paragraphes, et leurs associe, un numéro, et un nom. L'utilisation est ensuite des plus simple ...

 

Editer une documentation

L'édition de la documentation est réalisé sur un unique fichier et édité en mode RTF que vous pouvez mettre a jours a votre convenance a l'aide de l'éditeur de documentation.

La fonction G de la classe AUTODOC, identifie les paragraphes pouvant etres affichés indépendament, par la balise [doc] placée en début de ligne, suivie du titre et finalisé par le symbole ":"

    [doc]TITRE DE PARAGRAPHE :

    Texte et image

    [doc]FIN DE PROGRAMME :

    Texte et images.

    [doc]LECTEUR EN DUO :

    Texte et images

Nous obtenons ici 3 chapitres, pouvant êtres affichés indépendamment dans l'interface de visualisation.

 

Imprimer cette page