Changeset 74650 in spip-zone


Ignore:
Timestamp:
Aug 8, 2013, 11:06:15 AM (6 years ago)
Author:
marcimat@…
Message:

Options pour avoir des infos en plus sur la page sommaire générée si on le souhaite.
Uniformisation de la CSS avec celle du thème pour SPIP

Location:
_galaxie_/code.spip.net/autodoc/trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _galaxie_/code.spip.net/autodoc/trunk/installation.md

    r74574 r74650  
    4747Par configuration :
    4848
    49         php autodoc/bin/autodoc.php -c config.xml
     49        php autodoc/bin/autodoc.php -c phpdoc.xml
    5050
    5151Dans le fichier de configuration :
     
    5555                <transformations>
    5656                        <template name="autodoc/templates/zora">
    57                         <!--template name="responsive-twig"/ -->
     57                        <!-- template name="responsive-twig"/ -->
    5858                        <!-- template name="clean"/ -->
    5959                </transformations>
    6060        </phpdocumentor>
     61
     62
     63Autres options de configuration
     64-------------------------------
     65
     66Dans le fichier `phpdoc.xml` il est possible de définir les options suivantes
     67qui agissent uniquement avec le template Zora :
     68
     69        <options>
     70                <site     value="http://code.spip.net/" />
     71                <proposer value="oui" />
     72                <introduction value="Documentation automatique du code PHP de SPIP." />
     73                <presentation value="Cette documentation est extraite automatiquement à partir du code source
     74                        PHP de la version en développement de SPIP." />
     75        </options>
     76
     77- site :
     78      si présent, le lien clicable du logo et du titre dans l'entête des pages renvoie vers cette URL.
     79      sinon, par défaut, cela renvoie vers le sommaire de la documentation automatique générée.
     80- proposer :
     81      si présent, des boutons «proposer une amélioration» sont ajoutés sous certaines descriptions
     82      d'éléments. Ces liens pointent sur l'URL donnée par le paramètre site, sous entendant que c'est
     83      un site SPIP ayant activé le plugin Zora Docblock (préfixe zoradocblock), qui permet de gérer
     84      ces demandes d'amélioration.
     85- description :
     86      si présent, ajoute cette information sur le sommaire de la documentation automatique générée.
     87- presentation :
     88      si présent, ajoute cette information sur le sommaire de la documentation automatique générée.
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/content/dist.twig

    r74606 r74650  
    1 <h1>Bloc Contenu : {{ z_page }}</h1>
     1<section>
     2        <header class="cartouche">
     3                <h1>Bloc Contenu : {{ z_page }}</h1>
     4        </header>
     5
     6        <div class="main">
     7
     8                {%- if (configuration.options.description.value) -%}
     9                        <div id="descriptif_site_spip" class='lead'><p>{{ configuration.options.description.value }}</p></div>
     10                {%- endif -%}
     11
     12                {%- if (configuration.options.presentation.value) -%}
     13                        <div class="hero-unit item hentry">
     14                                <div class="texte entry-content"><p>{{ configuration.options.presentation.value }}</p></div>
     15                        </div>
     16                {%- endif -%}
    217
    318
     19                <h2>Path calculé : <em>{{ path(node) }}</em>.</h2>
    420
    521
    6 {% if (project.files.count > 0) %}
    7 <table class="table table-bordered table-striped">
    8         <thead>
    9                 <tr>
    10                         <th>Fichier</th>
    11                         <th>Chemin</th>
    12                         <th>Résumé</th>
    13                 </tr>
    14         </thead>
    15         <tbody>
    16                 {% for file in project.files %}
    17                 <tr>
    18                         <td><a href="{{ path(file) }}">{{ file.name }}</a></td>
    19                         <td>{{ file.path }}</td>
    20                         <td>{{ file.summary }}</td>
    21                 </tr>
    22                 {% endfor %}
    23         </tbody>
    24 </table>
    25 {% endif %}
     22                {% if (project.files.count > 0) %}
     23                <table class="table table-bordered table-striped">
     24                        <thead>
     25                                <tr>
     26                                        <th>Fichier</th>
     27                                        <th>Chemin</th>
     28                                        <th>Résumé</th>
     29                                </tr>
     30                        </thead>
     31                        <tbody>
     32                                {% for file in project.files %}
     33                                <tr>
     34                                        <td><a href="{{ path(file) }}">{{ file.name }}</a></td>
     35                                        <td>{{ file.path }}</td>
     36                                        <td>{{ file.summary }}</td>
     37                                </tr>
     38                                {% endfor %}
     39                        </tbody>
     40                </table>
     41                {% endif %}
    2642
    2743
    28 <pre>
    29 {{ dump(project.indexes.directories) }}
    30 </pre>
     44                <pre>
     45                {{ dump(project.indexes.directories) }}
     46                </pre>
     47
     48        </div>
     49</section>
     50
     51
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/css/perso.css

    r74548 r74650  
     1
     2/* typo */
    13body {
    24    font-size:90%;
     
    79code {
    810    font-family:"Courier New", Courier, monospace;
    9 }
    10 
     11    font-size: 0.9em;
     12    padding: 0;
     13}
     14pre {white-space: pre;}
     15
     16
     17/* liens */
    1118/* violet #B476AF , 91548C */
    12 
    1319a {
    1420    color: #91548C;
     
    1723    color: #6D446A;
    1824}
    19 pre {white-space: pre;}
    20 
     25
     26/* titraille */
    2127h1,.h1,.h1-like { font-size: 2em; line-height: 1em; margin-bottom: .5em; }
    2228h2,.h2,.h2-like { font-size: 1.5em; line-height: 1em; margin-bottom: .5em; }
     
    3036h3 small,.h3 small, .h3-like small { font-size: 0.80em; }
    3137
     38h1 small {
     39        color:#555;
     40        display: block;
     41}
     42
    3243h2.intertitre {
    3344    margin-top:2em; /*color:#91548C;*/
    3445    clear:both;
    3546}
     47
     48
    3649/* personnalisations */
     50
     51/* entetes */
    3752.header {
    3853    background-color: #660e5c;
     
    6176    background:url(../images/logo.png) no-repeat top left;
    6277}
     78
     79/* barre de navigation */
    6380.navbar .babarre {margin-left:150px;}
    6481.navbar .nav > li > a { padding:10px; }
     
    7188}
    7289
    73 .comments { margin-top: 4em; }
    74 
     90/* bloc principal */
     91.principal { margin-top:3em; }
     92
     93/* pied de page */
    7594.footer {
    7695    background-color: #F5F5F5;
     
    7998    padding: 40px 0;
    8099}
    81 
    82 
     100.footer .generator { right:2em; top:40px; }
     101
     102
     103/* barre de menu latérale */
    83104.menunav {
    84105    background-color: #FFFFFF;
     
    119140}
    120141
     142/* fil d'ariane */
    121143.breadcrumb {margin-bottom:2em; margin-top: 1em;}
    122144
     145/* blocs dépliables */
    123146.accordion-heading .description {display:block; color:#666; margin-top:.2em;}
    124147.accordion-heading .description:hover {text-decoration:none;}
     
    144167.accordion .accordion-heading.deprecated a {background:url('../images/deprecated-48.png') top right no-repeat;}
    145168
    146 table tr.deprecated td,
    147 table tr.deprecated th {background-color:#FFE3E4 !important;}
    148 
     169/* [autodoc] présentation d'une partie d'un élément */
    149170.appel { border-bottom:2px solid #f90; padding:1em; background:#FFEFC2;}
    150171.partie { padding: .5em 1em; background-color:#FFF5CF; margin-top:1em; border-radius:5px;}
     
    152173.partie.api {background:#FFF5CF url('../images/api-32.png') top right no-repeat;}
    153174
     175/* coloration de la signature d'une fonction */
    154176.coloration .nom {font-weight:bold; color:#FF6600;}
    155177.coloration .parenthese {color:#BA4000;}
     
    162184.coloration .defaut {color:#655CFF;}
    163185
     186
     187/* liste résumées, mais avec sous-titre */
     188.entry-title .sous_titre {color:#505050; font-size:85%; display:block; margin-top:2px;}
     189.article.entry .entry-title {
     190    margin-bottom: 0px;
     191}
     192
     193/* blocs d'information dans un flux de texte */
     194.warning {
     195    background-color: #FFF1B0;
     196    border: 1px solid #FFB522;
     197    color: #413726;
     198    text-shadow: none;
     199}
     200
     201.info {
     202    background-color: #D9EDF7;
     203    border: 1px solid #66B1C2;
     204    color: #162B34;
     205    text-shadow: none;
     206}
     207
     208/* cartouches */
     209.cartouche .publication, .hero-unit .publication {
     210    opacity: 0.7;
     211    text-align:right;
     212}
     213.article.entry .entry-content{
     214        color:#444;
     215        margin-bottom:0;
     216}
     217.long .publication { opacity: 0.7; }
     218.chapo {
     219    font-weight:normal;
     220    font-size:120%;
     221}
     222
     223
     224/* ajax */
    164225.chargement {background:#f6f6f6 url('../images/loader-32.gif') 10px 10px no-repeat;
    165226        margin-top:5px;
     
    170231 }
    171232
     233/* colonnes */
    172234.colonnes {
    173235        -moz-column-count: 3;
     
    196258}
    197259
     260/* hero (presentation, mise en exergue) */
     261.hero-unit {
     262    padding:1.5em 1.5em .5em;
     263    font-size:1.1em;
     264    background-color: #7a4482;
     265    color:white;
     266}
     267.hero-unit a { color:#fefc08;}
     268.hero-unit a:hover { color:#333;}
     269
     270/* décoration des tableaux */
     271table { width:100%; margin:2em 0;}
     272table td, table th { padding: 0.3em 0.4em; }
     273table tr { border-bottom:  1px dotted #ccc; }
     274table tr:last-child { border-bottom:  1px solid #cfcfcf; }
     275table caption { border-bottom:  1px solid #cfcfcf; padding:.2em; }
     276table thead tr { border-bottom:  1px solid #cfcfcf; background:#f6f6f6; }
     277
     278/* spécifique a autodoc */
     279
     280/* [autodoc] tableaux */
     281table tr.deprecated td,
     282table tr.deprecated th {background-color:#FFE3E4 !important;}
     283
     284/* [autodoc] bouton proposer une amélioration */
    198285a.proposer {margin-top:1em; float:right;}
    199286a.proposer:after {clear:both;}
     287
  • _galaxie_/code.spip.net/autodoc/trunk/templates/zora/extra/dist.twig

    r74606 r74650  
    22{% if project.files.count %}
    33        <h2 class='hide'>Liste des dossiers et fichiers</h2>
    4         <h2 class='hide'>{{ path(node) }}</h2>
     4
    55        <ul class='nav nav-list menunav'>
    66                <li class='groupe{% if path('/') == path(node) %} active{% endif %}'>
Note: See TracChangeset for help on using the changeset viewer.