Changeset 92911 in spip-zone


Ignore:
Timestamp:
Nov 14, 2015, 12:36:56 PM (4 years ago)
Author:
marcimat@…
Message:

Pour Éric : gérer un paramètre d'appel supplémentaire sur le helper nommé --avec_boussole_spip qui ajuotera la boussole SPIP sur la documentation générée.
De même, alternativement, --topnav=URL ajoutera le js contenu dans l'url indiquée dans le header.

Exemple : autodoc/bin/autodoc_helper from:file --avec_boussole_spip
Génère la documentation des plugins de la zone, avec la boussole intégrée.

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

Legend:

Unmodified
Added
Removed
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromDirectory.php

    r83635 r92911  
    2828            ->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'default')
    2929            ->addOption('sortie', 's', InputOption::VALUE_OPTIONAL, "Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output/{prefixe}'</comment>")
     30            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     31            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3032            ;
    3133    }
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromFile.php

    r83635 r92911  
    3636            ->addArgument('file', InputArgument::OPTIONAL, "Chemin du fichier. Peut être une adresse SVN.", 'svn://zone.spip.org/spip-zone/autodoc.txt')
    3737            ->addOption('sorties', 's', InputOption::VALUE_OPTIONAL, "Répertoire stockant toutes les documentations générées. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output'</comment>")
     38            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     39            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3840            ;
    3941    }
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromPlugin.php

    r83635 r92911  
    2929            ->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'plugin')
    3030            ->addOption('sortie', 's', InputOption::VALUE_OPTIONAL, "Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output/{prefixe}'</comment>")
     31            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     32            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3133            ;
    3234    }
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromSpip.php

    r83635 r92911  
    2828            ->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, "Préfixe servant au stockage des données", 'spip')
    2929            ->addOption('sortie', 's', InputOption::VALUE_OPTIONAL, "Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output/{prefixe}'</comment>")
    30 
     30            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     31            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3132#            ->addOption('titre', '', InputOption::VALUE_OPTIONAL, 'Titre du projet. Utilise le nom de la branche par défaut.')
    3233#            ->addOption('description',  '', InputOption::VALUE_OPTIONAL, 'Description du projet. Prédéfini sur le titre par défaut.')
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromSvn.php

    r83635 r92911  
    2929            ->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'default')
    3030            ->addOption('sortie', 's', InputOption::VALUE_OPTIONAL, "Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output/{prefixe}'</comment>")
     31            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     32            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3133            ;
    3234    }
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Command/FromZone.php

    r83635 r92911  
    2929            ->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'plugin')
    3030            ->addOption('sortie', 's', InputOption::VALUE_OPTIONAL, "Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output/{prefixe}'</comment>")
     31            ->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS dont le contenu est inséré dans le head html. <comment>Exemple : 'http://boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
     32            ->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
    3133            ;
    3234    }
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Generator.php

    r92819 r92911  
    166166
    167167        $timerStart = microtime(true);
     168
     169        // Option boussole SPIP => topnav.
     170        if ($this->getOption('avec_boussole_spip')) {
     171            $this->setOption('topnav', 'http://boussole.spip.net/?page=spipnav.js&lang=fr');
     172        }
    168173
    169174        // définir les chemins et faire tourner le backup précédent
     
    220225            }
    221226        }
     227
    222228
    223229        $nb_erreur = 0;
     
    303309        $twig   = new \Twig_Environment($loader);
    304310
     311        if ($topnav = $this->getOption('topnav', '')) {
     312            $topnav = @file_get_contents($topnav);
     313        }
     314        if (!$topnav) $topnav = '';
     315
    305316        $content = $twig->render('index.html', array(
    306317            'titre' => 'Documentation automatique des plugins SPIP',
    307318            'plugins' => $plugins,
     319            'topnav' => $topnav,
    308320        ));
    309321        file_put_contents($index, $content);
     
    686698        $source = $this->dirs['input'];
    687699        $is_spip = false;
     700
    688701        if (!file_exists($paquet = $source . '/paquet.xml')) {
    689702            $is_spip = true;
     
    794807        $template = file_get_contents($template);
    795808
     809        // c'est pas le meilleur endroit pour faire ça… mais bon.
     810        if ($this->getOption('avec_boussole_spip')) {
     811            $this->setOption('topnav', 'http://boussole.spip.net/?page=spipnav.js&lang=fr');
     812        }
     813
    796814        $substitutions = array(
    797815            '@DIR_CACHE@'  => $this->dirs['cache'],
     
    806824            '@OPT_TITRE_ONGLETS@' => $this->escape_xml_attr($this->getOption('titre_onglets', 'Sommaire')),
    807825            '@OPT_SITE@'          => $this->escape_xml_attr($this->getOption('site', '')),
     826            '@OPT_TOPNAV@'        => $this->escape_xml_attr($this->getOption('topnav', '')),
    808827        );
    809828
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/Template/index.html

    r75117 r92911  
    1313                <script src="__data/js/jquery.min.js"></script>
    1414                <script src="__data/bootstrap/js/bootstrap.min.js"></script>
     15
     16                {%- if topnav %}
     17                <script type="text/javascript">
     18                        {{ topnav|raw }}
     19                </script>
     20                {%- endif -%}
    1521        </head>
    1622
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Helpers/phpdoc_helper.xml

    r87994 r92911  
    6464        <option name="titre_onglets" value="@OPT_TITRE_ONGLETS@" />
    6565        <option name="site"          value="@OPT_SITE@" />
     66        <option name="topnav"        value="@OPT_TOPNAV@" />
    6667<!--
    6768        <option name="proposer"      value="oui" />
    68         <option name="topnav"        value="http://boussole.spip.net/?page=spipnav.js&amp;lang=fr" />
    6969        <option name="chemin"        value="autodoc/" />
    7070-->
  • _galaxie_/code.spip.net/autodoc/trunk/src/autodoc/Plugin/Core/Compiler/Pass/GetTopNav.php

    r87994 r92911  
    5252    {
    5353        $topnav = $this->app['config']->getOptions()->get('topnav');
    54         if (!$topnav) return;
     54        if (!$topnav OR !$topnav->getValue()) return;
    5555
    5656        $js = file_get_contents($topnav->getValue());
Note: See TracChangeset for help on using the changeset viewer.