Overview
Comment: | Update static HTML doc |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | dev |
Files: | files | file ages | folders |
SHA3-256: |
2cb692084669be4a86ae68773264b038 |
User & Date: | bohwaz on 2023-05-31 23:47:03 |
Other Links: | branch diff | manifest | tags |
Context
2023-06-01
| ||
00:02 | Fix empty attachments list check-in: 458b8a0d7a user: bohwaz tags: dev | |
2023-05-31
| ||
23:47 | Update static HTML doc check-in: 2cb6920846 user: bohwaz tags: dev | |
23:45 | Implement video support in markdown check-in: 1496202bdb user: bohwaz tags: dev | |
Changes
Modified src/www/admin/static/doc/brindille_sections.html from [7038562b44] to [cab7dda856].
︙ | ︙ | |||
71 72 73 74 75 76 77 78 79 80 81 82 83 84 | <li><a href="#users">users</a></li> <li><a href="#subscriptions">subscriptions</a> </ol></li> <li><a href="#comptabilite">Comptabilité</a> <ol> <li><a href="#accounts">accounts</a></li> <li><a href="#balances">balances</a></li> <li><a href="#years">years</a> </ol></li> <li><a href="#pour-le-site-web">Pour le site web</a> <ol> <li><a href="#breadcrumbs">breadcrumbs</a></li> <li><a href="#pages-articles-categories-sup-sql-sup">pages, articles, categories <sup>(sql)</sup></a></li> <li><a href="#files-documents-images-sup-sql-sup">files, documents, images <sup>(sql)</sup></a> | > | 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | <li><a href="#users">users</a></li> <li><a href="#subscriptions">subscriptions</a> </ol></li> <li><a href="#comptabilite">Comptabilité</a> <ol> <li><a href="#accounts">accounts</a></li> <li><a href="#balances">balances</a></li> <li><a href="#transactions">transactions</a></li> <li><a href="#years">years</a> </ol></li> <li><a href="#pour-le-site-web">Pour le site web</a> <ol> <li><a href="#breadcrumbs">breadcrumbs</a></li> <li><a href="#pages-articles-categories-sup-sql-sup">pages, articles, categories <sup>(sql)</sup></a></li> <li><a href="#files-documents-images-sup-sql-sup">files, documents, images <sup>(sql)</sup></a> |
︙ | ︙ | |||
323 324 325 326 327 328 329 | <p>Il est également possible de passer des arguments dans les paramètres à l'aides des arguments nommés qui commencent par deux points <code>:</code> :</p> <pre><code>{{#articles where="title = :montitre" :montitre="Actualité"}}</code></pre> <h1 id="membres">Membres</h1> <h2 id="users">users</h2> <p>Liste les membres.</p> <p>Paramètres possibles :</p> <p>| <code>id</code> | optionnel | Identifiant unique du membre, ou tableau contenant une liste d'identifiants. |<br /> | | > > > > > > > > > > > > > | > > > > | > > > > | > > > | 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <p>Il est également possible de passer des arguments dans les paramètres à l'aides des arguments nommés qui commencent par deux points <code>:</code> :</p> <pre><code>{{#articles where="title = :montitre" :montitre="Actualité"}}</code></pre> <h1 id="membres">Membres</h1> <h2 id="users">users</h2> <p>Liste les membres.</p> <p>Paramètres possibles :</p> <p>| <code>id</code> | optionnel | Identifiant unique du membre, ou tableau contenant une liste d'identifiants. |<br /> | <code>search_name</code> | optionnel | Ne lister que les membres dont le nom correspond au texte passé en paramètre. |<br /> | <code>id_parent</code> | optionnel | Ne lister que les membres rattachés à l'identifiant unique du membre responsable indiqué. |</p> <p>Chaque itération renverra la fiche du membre, ainsi que ces variables :</p> <p>| <code>$id</code> | Identifiant unique du membre |<br /> | <code>$_name</code> | Nom du membre, tel que défini dans la configuration |<br /> | <code>$_login</code> | Identifiant de connexion du membre, tel que défini dans la configuration |<br /> | <code>$_number</code> | Numéro du membre, tel que défini dans la configuration |</p> <h2 id="subscriptions">subscriptions</h2> <p>Liste les inscriptions à une ou des activités.</p> <p>Paramètres possibles :</p> <table> <thead> <tr> <th style="text-align: left;">Paramètre</th> <th style="text-align: left;"></th> <th style="text-align: left;">Fonction</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><code>user</code></td> <td style="text-align: left;">optionnel</td> <td style="text-align: left;">Identifiant unique du membre</td> </tr> <tr> <td style="text-align: left;"><code>active</code></td> <td style="text-align: left;">optionnel</td> <td style="text-align: left;">Si <code>TRUE</code>, seules les inscriptions à jour sont listées</td> </tr> <tr> <td style="text-align: left;"><code>id_service</code></td> <td style="text-align: left;">optionnel</td> <td style="text-align: left;">Ne renvoie que les inscriptions à l'activité correspondant à cet ID.</td> </tr> </tbody> </table> <h1 id="comptabilite">Comptabilité</h1> <h2 id="accounts">accounts</h2> <p>Liste les comptes d'un plan comptable.</p> <table> <thead> <tr> <th style="text-align: left;">Paramètre</th> |
︙ | ︙ | |||
372 373 374 375 376 377 378 | <tbody> <tr> <td style="text-align: left;"><code>codes</code> (optionel)</td> <td style="text-align: left;">Ne renvoyer que les balances des comptes ayant ces codes (séparer par des virgules).</td> </tr> <tr> <td style="text-align: left;"><code>year</code> (optionel)</td> | | > > > > > > > > > > > > > > > > > > > > > > > | 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 | <tbody> <tr> <td style="text-align: left;"><code>codes</code> (optionel)</td> <td style="text-align: left;">Ne renvoyer que les balances des comptes ayant ces codes (séparer par des virgules).</td> </tr> <tr> <td style="text-align: left;"><code>year</code> (optionel)</td> <td style="text-align: left;">Ne renvoyer que les balances des comptes utilisés sur l'année (indiquer ici un ID de year).</td> </tr> </tbody> </table> <h2 id="transactions">transactions</h2> <p>Renvoie des écritures.</p> <table> <thead> <tr> <th style="text-align: left;">Paramètre</th> <th style="text-align: left;"></th> <th style="text-align: left;">Fonction</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;"><code>id</code></td> <td style="text-align: left;">optionnel</td> <td style="text-align: left;">Indiquer un ID d'écriture pour récupérer ses informations.</td> </tr> <tr> <td style="text-align: left;"><code>user</code></td> <td style="text-align: left;">optionnel</td> <td style="text-align: left;">Indiquer ici un ID utilisateur pour lister les écritures liées à un membre.</td> </tr> </tbody> </table> <h2 id="years">years</h2> <p>Liste les exercices comptables</p> <table> <thead> |
︙ | ︙ |
Modified src/www/admin/static/doc/markdown.html from [684b12e976] to [47747ea422].
︙ | ︙ | |||
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 | <li><a href="#identifiant-et-classe-css-sur-les-titres">Identifiant et classe CSS sur les titres</a></li> <li><a href="#classes-css">Classes CSS</a></li> <li><a href="#tags-html">Tags HTML</a> </ol></li> <li><a href="#extensions">Extensions</a> <ol> <li><a href="#images-jointes">Images jointes</a></li> <li><a href="#fichiers-joints">Fichiers joints</a></li> <li><a href="#sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</a> <ol> <li><a href="#exclure-un-sous-titre-du-sommaire">Exclure un sous-titre du sommaire</a> </ol></li> <li><a href="#grilles-et-colonnes">Grilles et colonnes</a></li> <li><a href="#alignement-du-texte">Alignement du texte</a></li> <li><a href="#couleurs">Couleurs</a> | > > > > > | 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | <li><a href="#identifiant-et-classe-css-sur-les-titres">Identifiant et classe CSS sur les titres</a></li> <li><a href="#classes-css">Classes CSS</a></li> <li><a href="#tags-html">Tags HTML</a> </ol></li> <li><a href="#extensions">Extensions</a> <ol> <li><a href="#images-jointes">Images jointes</a></li> <li><a href="#galerie-d-images">Galerie d'images</a> <ol> <li><a href="#diaporama-d-images">Diaporama d'images</a> </ol></li> <li><a href="#fichiers-joints">Fichiers joints</a></li> <li><a href="#videos">Vidéos</a></li> <li><a href="#sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</a> <ol> <li><a href="#exclure-un-sous-titre-du-sommaire">Exclure un sous-titre du sommaire</a> </ol></li> <li><a href="#grilles-et-colonnes">Grilles et colonnes</a></li> <li><a href="#alignement-du-texte">Alignement du texte</a></li> <li><a href="#couleurs">Couleurs</a> |
︙ | ︙ | |||
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 | <li>Légende : indiquer ici une courte description de l'image.</li> </ul> <p>Exemple :</p> <pre><code><<image|mon_image.png|center|Ceci est une belle image>></code></pre> <p>Il est aussi possible d'utiliser la syntaxe avec des paramètres nommés :</p> <pre><code><<image file="Nom_fichier.jpg" align="center" caption="Légende">></code></pre> <p>Les images qui ne sont pas mentionnées dans le texte seront affichées après le texte sous forme de galerie.</p> <h2 id="fichiers-joints">Fichiers joints</h2> <p>Pour créer un bouton permettant de voir ou télécharger un fichier joint à la page web, il suffit d'utiliser la syntaxe suivante :</p> <pre><code><<file|Nom_fichier.ext|Libellé>></code></pre> <ul> <li><code>Nom_fichier.ext</code> : remplacer par le nom du fichier (parmi les fichiers joints à la page)</li> <li><code>Libellé</code> : indique le libellé du qui sera affiché sur le bouton, si aucun libellé n'est indiqué alors c'est le nom du fichier qui sera affiché</li> </ul> <h2 id="sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</h2> <p>Il est possible de placer le code <code><<toc>></code> pour générer un sommaire automatiquement à partir des titres et sous-titres :</p> <pre><code><<toc>></code></pre> <p>Affichera un sommaire comme celui-ci :</p><div class="toc"> <ol> <li><a href="#syntaxe-markdown">Syntaxe MarkDown</a> <ol> | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | <li>Légende : indiquer ici une courte description de l'image.</li> </ul> <p>Exemple :</p> <pre><code><<image|mon_image.png|center|Ceci est une belle image>></code></pre> <p>Il est aussi possible d'utiliser la syntaxe avec des paramètres nommés :</p> <pre><code><<image file="Nom_fichier.jpg" align="center" caption="Légende">></code></pre> <p>Les images qui ne sont pas mentionnées dans le texte seront affichées après le texte sous forme de galerie.</p> <h2 id="galerie-d-images">Galerie d'images</h2> <p>Il est possible d'afficher une galerie d'images (sous forme d'images miniatures) avec la balise <code><<gallery</code> qui contient la liste des images à mettre dans la galerie :</p> <pre><code><<gallery Nom_fichier.jpg Nom_fichier_2.jpg >></code></pre> <p>Si aucun nom de fichier n'est indiqué, alors toutes les images jointes à la page seront affichées :</p> <pre><code><<gallery>></code></pre> <h3 id="diaporama-d-images">Diaporama d'images</h3> <p>On peut également afficher cette galerie sous forme de diaporama. Dans ce cas une seule image est affichée, et on peut passer de l'une à l'autre.</p> <p>La syntaxe est la même, mais on ajoute le mot <code>slideshow</code> après le mot <code>gallery</code> :</p> <pre><code><<gallery slideshow Nom_fichier.jpg Nom_fichier_2.jpg >></code></pre> <h2 id="fichiers-joints">Fichiers joints</h2> <p>Pour créer un bouton permettant de voir ou télécharger un fichier joint à la page web, il suffit d'utiliser la syntaxe suivante :</p> <pre><code><<file|Nom_fichier.ext|Libellé>></code></pre> <ul> <li><code>Nom_fichier.ext</code> : remplacer par le nom du fichier (parmi les fichiers joints à la page)</li> <li><code>Libellé</code> : indique le libellé du qui sera affiché sur le bouton, si aucun libellé n'est indiqué alors c'est le nom du fichier qui sera affiché</li> </ul> <h2 id="videos">Vidéos</h2> <p>Pour inclure un lecteur vidéo dans la page web à partir d'un fichier vidéo joint à la page, il faut utiliser le code suivant :</p> <pre><code><<video|Nom_du_fichier.ext>></code></pre> <p>On peut aussi spécifier d'autres paramètres :</p> <ul> <li><code>file</code> : nom du fichier vidéo</li> <li><code>poster</code> : nom de fichier d'une image utilisée pour remplacer la vidéo avant qu'elle ne soit lue</li> <li><code>subtitles</code> : nom d'un fichier de sous-titres au format VTT (le format SRT n'est pas géré par les navigateurs)</li> <li><code>width</code> : largeur de la vidéo (en pixels)</li> <li><code>height</code> : hauteur de la vidéo (en pixels)</li> </ul> <p>Exemple :</p> <pre><code><<video file="Ma_video.webm" poster="Ma_video_poster.jpg" width="640" height="360" subtitles="Ma_video_sous_titres.vtt">></code></pre> <h2 id="sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</h2> <p>Il est possible de placer le code <code><<toc>></code> pour générer un sommaire automatiquement à partir des titres et sous-titres :</p> <pre><code><<toc>></code></pre> <p>Affichera un sommaire comme celui-ci :</p><div class="toc"> <ol> <li><a href="#syntaxe-markdown">Syntaxe MarkDown</a> <ol> |
︙ | ︙ | |||
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 | <li><a href="#identifiant-et-classe-css-sur-les-titres">Identifiant et classe CSS sur les titres</a></li> <li><a href="#classes-css">Classes CSS</a></li> <li><a href="#tags-html">Tags HTML</a> </ol></li> <li><a href="#extensions">Extensions</a> <ol> <li><a href="#images-jointes">Images jointes</a></li> <li><a href="#fichiers-joints">Fichiers joints</a></li> <li><a href="#sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</a> <ol> <li><a href="#exclure-un-sous-titre-du-sommaire">Exclure un sous-titre du sommaire</a> </ol></li> <li><a href="#grilles-et-colonnes">Grilles et colonnes</a></li> <li><a href="#alignement-du-texte">Alignement du texte</a></li> <li><a href="#couleurs">Couleurs</a> | > > > > > | 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | <li><a href="#identifiant-et-classe-css-sur-les-titres">Identifiant et classe CSS sur les titres</a></li> <li><a href="#classes-css">Classes CSS</a></li> <li><a href="#tags-html">Tags HTML</a> </ol></li> <li><a href="#extensions">Extensions</a> <ol> <li><a href="#images-jointes">Images jointes</a></li> <li><a href="#galerie-d-images">Galerie d'images</a> <ol> <li><a href="#diaporama-d-images">Diaporama d'images</a> </ol></li> <li><a href="#fichiers-joints">Fichiers joints</a></li> <li><a href="#videos">Vidéos</a></li> <li><a href="#sommaire-table-des-matieres-automatique">Sommaire / table des matières automatique</a> <ol> <li><a href="#exclure-un-sous-titre-du-sommaire">Exclure un sous-titre du sommaire</a> </ol></li> <li><a href="#grilles-et-colonnes">Grilles et colonnes</a></li> <li><a href="#alignement-du-texte">Alignement du texte</a></li> <li><a href="#couleurs">Couleurs</a> |
︙ | ︙ |