Browse Source

Basculer sur la norme P30-c pour l'intégration de la boussole (_eric_)

svn/root/trunk
marcimat@rezo.net 7 years ago
parent
commit
f812af9d16
  1. 2
      src/autodoc/Helpers/Command/FromDirectory.php
  2. 2
      src/autodoc/Helpers/Command/FromFile.php
  3. 2
      src/autodoc/Helpers/Command/FromPlugin.php
  4. 2
      src/autodoc/Helpers/Command/FromSpip.php
  5. 2
      src/autodoc/Helpers/Command/FromSvn.php
  6. 2
      src/autodoc/Helpers/Command/FromZone.php
  7. 9
      src/autodoc/Helpers/Generator.php
  8. 5
      src/autodoc/Helpers/Template/index.html
  9. 2
      src/autodoc/Plugin/Core/Compiler/Pass/GetTopNav.php
  10. 5
      templates/zora/inclure/head.twig

2
src/autodoc/Helpers/Command/FromDirectory.php

@ -27,7 +27,7 @@ class FromDirectory extends Command
->addArgument('directory', InputArgument::REQUIRED, "Chemin du répertoire. <comment>Exemple : '/home/user/www/spip/plugins/fabrique'</comment>")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'default')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
;
}

2
src/autodoc/Helpers/Command/FromFile.php

@ -35,7 +35,7 @@ svn://zone.spip.org/spip-zone/_plugins_/champs_extras/core/trunk;cextras
")
->addArgument('file', InputArgument::OPTIONAL, "Chemin du fichier. Peut être une adresse SVN.", 'svn://zone.spip.org/spip-zone/autodoc.txt')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
;
}

2
src/autodoc/Helpers/Command/FromPlugin.php

@ -28,7 +28,7 @@ class FromPlugin extends Command
->addArgument('chemin', InputArgument::REQUIRED, "Chemin depuis _plugins_ du svn de la zone. <comment>Exemple : 'fabrique/trunk'</comment>")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'plugin')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
;
}

2
src/autodoc/Helpers/Command/FromSpip.php

@ -27,7 +27,7 @@ class FromSpip extends Command
->addArgument('chemin', InputArgument::OPTIONAL, "Chemin dans l'arborescence du svn du core. <comment>Exemple : 'spip' ou 'branches/spip-3.0'</comment>", 'spip')
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, "Préfixe servant au stockage des données", 'spip')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
# ->addOption('titre', '', InputOption::VALUE_OPTIONAL, 'Titre du projet. Utilise le nom de la branche par défaut.')
# ->addOption('description', '', InputOption::VALUE_OPTIONAL, 'Description du projet. Prédéfini sur le titre par défaut.')

2
src/autodoc/Helpers/Command/FromSvn.php

@ -28,7 +28,7 @@ class FromSvn extends Command
->addArgument('source', InputArgument::REQUIRED, "URL de la source SVN. <comment>Exemple : 'svn://trac.rezo.net/spip/spip'</comment>")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'default')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
;
}

2
src/autodoc/Helpers/Command/FromZone.php

@ -28,7 +28,7 @@ class FromZone extends Command
->addArgument('chemin', InputArgument::REQUIRED, "Chemin dans l'arborescence du svn de la zone. <comment>Exemple : '_plugins_/fabrique/trunk'</comment>")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données', 'plugin')
->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>")
->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>")
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, "URL d'un fichier JS à charger dans le head html. <comment>Exemple : '//boussole.spip.net/?page=spipnav.js&lang=fr'</comment>")
->addOption('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
;
}

9
src/autodoc/Helpers/Generator.php

@ -168,7 +168,7 @@ class Generator
// Option boussole SPIP => topnav.
if ($this->getOption('avec_boussole_spip')) {
$this->setOption('topnav', 'http://boussole.spip.net/?page=spipnav.js&lang=fr');
$this->setOption('topnav', '//boussole.spip.net/?page=spipnav.js&lang=fr');
}
// définir les chemins et faire tourner le backup précédent
@ -308,10 +308,7 @@ class Generator
$loader = new \Twig_Loader_Filesystem( $this->dirs['helper'] . '/Template' );
$twig = new \Twig_Environment($loader);
if ($topnav = $this->getOption('topnav', '')) {
$topnav = @file_get_contents($topnav);
}
if (!$topnav) $topnav = '';
$topnav = $this->getOption('topnav', '');
$content = $twig->render('index.html', array(
'titre' => 'Documentation automatique des plugins SPIP',
@ -808,7 +805,7 @@ class Generator
// c'est pas le meilleur endroit pour faire ça… mais bon.
if ($this->getOption('avec_boussole_spip')) {
$this->setOption('topnav', 'http://boussole.spip.net/?page=spipnav.js&lang=fr');
$this->setOption('topnav', '//boussole.spip.net/?page=spipnav.js&lang=fr');
}
$substitutions = array(

5
src/autodoc/Helpers/Template/index.html

@ -15,7 +15,10 @@
{%- if topnav %}
<script type="text/javascript">
{{ topnav|raw }}
(function() {
var d=document,g=d.createElement('script'),s=d.getElementsByTagName('script')[0];
g.type='text/javascript';g.defer=true;g.async=true;g.src="{{ topnav|raw }}";s.parentNode.insertBefore(g,s);
})();
</script>
{%- endif -%}
</head>

2
src/autodoc/Plugin/Core/Compiler/Pass/GetTopNav.php

@ -53,7 +53,7 @@ class GetTopNav implements CompilerPassInterface
$topnav = $this->app['config']->getOptions()->get('topnav');
if (!$topnav OR !$topnav->getValue()) return;
$js = file_get_contents($topnav->getValue());
$js = $topnav->getValue();
$topnav = new Collection(array(
'js' => $js

5
templates/zora/inclure/head.twig

@ -13,6 +13,9 @@
{%- if project.indexes.topnav.js %}
<script type="text/javascript">
{{ project.indexes.topnav.js|raw }}
(function() {
var d=document,g=d.createElement('script'),s=d.getElementsByTagName('script')[0];
g.type='text/javascript';g.defer=true;g.async=true;g.src="{{ project.indexes.topnav.js|raw }}";s.parentNode.insertBefore(g,s);
})();
</script>
{%- endif -%}

Loading…
Cancel
Save