Outils pour utilisateurs

Outils du site


public:documentation

← retour à l'accueil

Documentation du code TXM RCP et Toolbox

Javadoc

  • Javadoc mise à jour à chaque release :
  • Pour la Javadoc courante :
    • Installer&Lancer Eclipse RCP&RAP
    • Récupérer les sources depuis le repository SVN
    • Importer les projets avec la commande Fichier > Importer. Sélectionner le type de projet “General” puis “Existing project from directory”
    • Sélectionner tous les projets TXM
    • Exporter les projets avec la commande “Fichier > Exporter”. Sélectioner “Java/Javadoc”
      • dans la page suivante, indiquer le répertoire destination
      • dans la page suivante, ne rien changer
      • dans la page suivante, indiquer le“JRE source compatibility” à 1.8 et cocher “Open generated index file in browser”

Sources

Macros

Langages

Java

Groovy

R

C

Javascript

Environnement de développement

Tycho

Depuis Eclipse 4.6, les products (update-site, etc.) Eclipse et sous-projets sont construits avec Tycho.

Version Java à utiliser : 8

Commandes courantes :

  • mvn clean : supprime tous les fichiers binaires. Par exemple les répertoires “target”
  • mvn verify : construit une version SNAPSHOT de tous les projets identifiés
  • mvn install : construit une livraison de tous les projets identifiés

Extension utiles :

  • tycho-pomless → tycho-build (a été renommé) : permet de générer les fichiers pom.xml pour chaque projet plugins, features, product, update-site…

Tycho est + strict qu'Eclipse dans les configurations :

  • plugin.xml
    • pas de doublons (le PDE peut en générer facilement)
  • features.xml
    • pas de cycle

Documentation :

Eclipse

Inclure les .class Groovy d'un plugin dans le build

Ajouter les lignes suivante aux fichier build.properties des projets :

sourceFileExtensions=*.java, *.groovy
compilerAdapter=org.codehaus.groovy.eclipse.ant.GroovyCompilerAdapter
compilerAdapter.useLog=true  # this ensures that exceptions are logged to the proper log file.

Erreur "plugin XXX could not instanciate XXX.MaClasse". raisons possibles

  • pas d'export du fichier “plugin.xml” dans “bin.includes” de build.properties
  • la classe qui implémente le point d'extension est abstraite
  • il manque des dépendances non exportées
  • “.” est absent du “bin.includes” de build.properties

Versionnage

Installeurs

Windows

  • Nsis

Mac OS X

Linux

Linux

Environnement Huma-Num

Environnement Sourceforge

Obtenir un shell sur SF

Voir https://sourceforge.net/p/forge/documentation/SSH.

  • si nécessaire, régler sa clé publique SSH pour SF
    • si nécessaire, créer sa clé publique SSH pour SF (version Linux)
      • dans un shell :
        ssh-keygen -t rsa -C "USERNAME@shell.sf.net"
    • se connecter à SF : https://sourceforge.net/auth
    • aller dans Me > Accounts Settings > SSH Settings
    • coller le contenu de la clé publique :
      cat ~/.ssh/id_rsa.pub
  • dans un shell :
    ssh -t USERNAME@shell.sourceforge.net create
    • chemins utiles :
      • répertoires des sources :
        cd /home/svn/p/txm
      • répertoires des fichiers web :
        cd /home/project-web/txm/htdocs
      • répertoires des files :
        cd /home/frs/project/txm
    • quitter :
      shutdown

Windows

Technologies

Moteur de recherche plein texte

Visualisation

Environnement

SQL

Géo

W3C, web, Internet

XML

  • Documentation XML

Unicode

Libre Office

MS Office

Markdown & Wiki

Analyse de Documents source

Graphisme

Sites web

Générateurs de site statique

Procédures Jekyll

Installer jekyll en local
sudo apt-get install ruby2.3-dev
sudo apt-get install ruby-bundler
sudo gem install jekyll
# plugins utiles
sudo gem install jekyll-paginate
sudo gem install jekyll-sitemap
sudo gem install jekyll-target-blank
sudo gem install jekyll-last-modified-at
sudo gem install jekyll-analytics
# pour chaque plugin, ajouter une ligne de la forme "  - jekyll-paginate" au champ "plugins:" du fichier "_config.yml"
Mise à jour de jekyll pour installer des nouveaux gems
sudo bundle install

A. récupérer un site jekyll distant sous git

git clone https://gitlab.in2p3.fr/sheiden/textometrie.org
Affichage local
bundle exec jekyll serve
Mettre à jour un projet jekyll local depuis le projet git distant
git pull origin master
Mettre à jour un projet jekyll distant après édition du site local
git checkout master
git add .
git commit -m "updated some pages"
git push origin HEAD:master
# contrôles avant push
git status -s

B. créer un site jekyll distant avec les Pages de Gitlab

  • puis [Create from template]
  • puis 'Pages/Jekyll' [Use template]
  • puis régler '_config.yml' avec :
    • title: "Textométrie // TXM"
    • email: "textometrie @ groupes.renater.fr"
    • baseurl: "/textometrie.org"
    • url: "https://sheiden.pages.in2p3.fr"
    • plugins: [éventuels]
  • le pipeline automatique de génération du site s'active (ou on l'active à la main - seul pipeline défini dans le projet)
  • le site est disponible à une adresse gitlab

C. créer un site jekyll local sous git

Créer un site jekyll local comme projet git
# réglage git
git config --global user.email serge.heiden@ens-lyon.fr
git config --global credential.helper cache
git config --global credential.helper 'cache --timeout=3600'
# crée projet
cd ~/git
git init textometrie.org
cd textometrie.org
git checkout --orphan website
# crée site
jekyll new .
git add .
touch README
git add README
# push git
git remote add origin git@gitlab.in2p3.fr:sheiden/textometrie.org.git
git commit -m "install textometrie.org website"
git push origin HEAD:website
# contrôles avant commit
git remote -v
git remote show origin
Augmenter un site jekyll en beautiful-jekyll
cd ~/git/textometrie.org
cp -r ~/Téléchargements/beautiful-jekyll-master/* .
public/documentation.txt · Dernière modification : 06/03/2024 10:00 de matthieu.decorde@ens-lyon.fr