Accueil : Différence entre versions

De OviWiki
Aller à : navigation, rechercher
(Outils de développements)
(Documentation interne)
 
(187 révisions intermédiaires par 12 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
== Contribuer au Wiki ==
+
== Documentations et références Ovidentia==
 
+
Bienvenue sur le Wiki dédié à Ovidentia.
+
 
+
Avant de contribuer, vous pouvez vous familiariser avec les [[Règles d'usage du wiki|règles d'usage du wiki]].
+
 
+
 
+
== Documentations ==
+
 
+
  
  
Ligne 13 : Ligne 5 :
  
 
|- valign="top"
 
|- valign="top"
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#F7FFEB;padding-bottom:0.5em;" width="50%"|
+
|width="50%" style="padding-right:.9em;"|
=== Manuel de l'utilisateur ===
+
  
* [[Congés]]
 
  
|valign="top" bgcolor="#FFF7F6" style="border-style:solid;border-width:1px;border-color:gray;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|
+
Bienvenue sur le site dédié à la documentation et aux références Ovidentia.
=== Manuel de l'administrateur ===
+
  
* [[Installer Ovidentia]]
+
Pour télécharger des documentations utilisateur et administrateur pour OVIDENTIA, vous pouvez utiliser le site communautaire [http://www.ovidentia.org/ Ovidentia.org].
* [[Sauvegarder Ovidentia]]
+
  
|}
+
Avant de contribuer, vous pouvez vous familiariser avec les [[Règles d'usage du wiki|règles d'usage du wiki]] et [[Aide à l'écriture MediaWiki|l'aide à l'écriture Mediawiki]].
  
 +
Le développement d'OVIDENTIA est initié et géré par [[Image:Cantico.svg||32px|logo cantico]] [http://www.cantico.fr Cantico]
  
== Création de skins ==
+
||
 +
<div class="bg-bloc bg-white">
 +
{{MenuItem
 +
|title      = [[:Catégorie:Développement de modules|Développer un module Ovidentia]]
 +
|description = Pour ajouter des nouvelles fonctionalités sur le portail, Ovidentia offre un ensemble d'interfaces de programmation.
 +
* [[Addon tutorial|Tutorial module]]
 +
* [[:Catégorie:Développement de skins|Introduction au développement de skins]]
 +
* [http://www.ovidentia.org/?tg=articles&topics=56 Autres types de contributions]
 +
|icon        = icon-addon-dev.jpg
 +
}}
  
{| cellpadding=0 cellspacing=5 width="100%"
 
  
|- valign="top"
+
{{MenuItem
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#FFF7EB;padding-bottom:0.5em;" width="100%"|
+
|title      = [[Feuille de route]] (Roadmap)
 +
|description = Voir aussi les [[:Catégorie:Technologies à l'étude|technologies à l'étude]]
 +
|icon        = Roadmap.jpg
 +
}}
  
* [[Documentation OVML]] (OVidentia Markup Language)
+
</div>
  
 
|}
 
|}
 +
== Administration ==
  
 +
<div class="bg-bloc bg-green">
 +
=== Maintenance ===
  
== Développement ==
+
'' ''
 +
{{MenuItem
 +
|title      = [[Installer et mettre à jour Ovidentia]]
 +
|description = Documentation pour l'installation et la mise à jour d'Ovidentia
 +
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Sauvegarde et restauration d'Ovidentia‎]]
 +
|description = Protégez vos données en les sauvegardant régulièrement.
 +
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Congés]]
 +
|description = Gérez les congés des utilisateurs dans le cadre d'un intranet.
 +
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Multi-sites]]
 +
|description = Gérez plusieurs sites ou plusieurs langues d'un même site à partir du même portail.
 +
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Thésaurus]]
 +
|description = Les mots-clés permettent à vos lecteurs de retrouver plus facilement vos articles et aux moteurs de recherche de mieux connaître le sujet de votre site.
 +
|icon        = Applications-development.png
 +
}}
  
{| cellpadding=0 cellspacing=5 width="100%"
+
</div>
  
 +
== Intégration ==
  
|- valign="top"
+
<div class="bg-bloc bg-violet">
|style="border: 1px solid gray;padding-left:1em;padding-right:0.5em;background:#E8F1FF;padding-bottom:0.5em;" width="50%"|
+
=== Code ===
+
* [[Règles de codage]]
+
* [[Sécurité]]
+
* [[Utilisation de Mantis]]
+
* [[Utilisation de CVS]] et gestion des versions
+
* [[Créer une archive de version]]
+
* [[Gestion des skins]]
+
* [[Gettext]]
+
* [[Implémentation de containers OVML dans un module]]
+
* [[Internationalisation]] : Améliorations de la gestion de l'internationalisation dans Ovidentia
+
  
=== Documentation des API ===
+
=== Skins ===
==== Noyau uniquement ====
+
<br />
* [[Nouveau moteur de templates]]
+
''Comment développer ou modifier des skins pour le portail.''
* [[API des agendas]]
+
{{MenuItem
==== Noyau et modules ====
+
|title      = [[Créer son skin]]
* [[Access Control List]], Droits d'accès
+
|description = Documentation pour la création d'un skin pour Ovidentia
* [[Base de registre]]
+
|icon        = Applications-development.png
* [[API de sélection d'utilisateurs]]
+
}}
* [[API du gestionnaire de fichier]]
+
{{MenuItem
* [[API du gestionnaire d'événement]]
+
|title      = [[Référence OvML]]
* [[API editeur]]
+
|description = Documentation de référence des fonctions et des containers OvML.
* [[API Addon - OVML]]
+
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Publication structurée]]
 +
|description = Documentation de référence des fonctions et des containers OvML de la publication structurée.
 +
|icon        = Applications-utilities.png
 +
}}
  
|valign="top" bgcolor="#E8F1FF" style="border-style:solid;border-width:1px;border-color:gray;padding-left:1em;padding-right:0.5em; padding-bottom:0.5em;" width="50%"|
+
</div>
  
=== Qualité et tests ===
+
== Développement ==
  
* [[Accessibilité]]
+
<div class="bg-bloc bg-white">
* [[W3C]]
+
Cette partie contient une introduction au développement des modules ainsi que diverses documentations sur les nouvelles interfaces de programmation disponibles dans les versions actuelles et futures d'OVIDENTIA.
* [[Développement d'une nouvelle fonctionnalité]]
+
* [[Tests de vérification à la sortie d'une version]]
+
  
=== Outils de développements ===
+
Le développement d'OVIDENTIA est initié et géré par [[Image:Cantico.svg||32px|logo cantico]] [http://www.cantico.fr Cantico]
 +
</div>
 +
{| cellpadding=0 cellspacing=5 width="100%"
 +
|- valign="top"
 +
|width="50%" style="padding-right:.9em;"|
 +
<div class="bg-bloc bg-orange">
  
===Eclipse===
+
=== Documentation des API du noyau ===
====Installation d'Eclipse PDT====
+
<br />
La version [http://www.eclipse.org/pdt/ PDT] (PHP Development Tools) d'Eclipse contient la plupart des outils nécessaires au développement d'applications PHP et en particulier d'Ovidentia.
+
''Contenu de l'[[:Catégorie:API Ovidentia|API Ovidentia]]. Ces API peuvent être utilisées dans le cadre du [[:Catégorie:Développement de modules|développement de modules]].''
 +
{{MenuItem
 +
|title      = [[API noyau/module]]
 +
|description = Fonctions toujours incluses dans Ovidentia
 +
}}
 +
{{MenuItem
 +
|title      = [[API des dates]]
 +
|description = Fonctions pour l'affichage des dates et l'objet BAB_DateTime pour effectuer des traitements complexes. Voir aussi : [[API des agendas]]
 +
|icon        = DateTime.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API des utilisateurs et des annuaires]]
 +
|description = Permet d'effectuer des traitements sur les utilisateurs et les fiches d'annuaires. Voir aussi : [[API de sélection d'utilisateurs]], [[API des organigrammes]]
 +
|icon        = User-info.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API des groupes]]
 +
|description = Accès aux groupes d'utilisateurs d'Ovidentia
 +
|icon        = Kuser.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API de gestion d'un module]]
 +
|description = Voir aussi : [[API Addon - OVML]] et [[Implémentation de containers OVML dans un module]]
 +
|icon        = Applications-development.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API Articles]]
 +
|description = Accès aux catégories de thèmes d'articles, aux thèmes d'articles et aux articles. Voir aussi [[API editeur]] pour utiliser l'éditeur WYSIWYG
 +
|icon        = Document-properties.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API d'envoi de mails]]
 +
|description = Classe d'envoi des email basée sur la configuration du portail.
 +
|icon        = Evolution-mail.png
 +
}}
 +
{{MenuItem
 +
|title      = [[:Catégorie:Recherche|Exploitation de la recherche]]
 +
|description = Recherche dans Ovidentia, Utilisation du thésaurus, Configuration du moteur d'indexation swish-e. Voir aussi : [[Paramètres de la recherche]], [[API de la recherche]], [[API des tags]], [[Indexation]]
 +
|icon        = Search.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API des ACL (Access Control List)]]
 +
|description = API des droits d'accès, pour tester ou créer des droits
 +
|icon        = Keys.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Base de registre]]
 +
|description = Cette API permet aux module et au noyau de mémoriser des paramètres de configuration
 +
|icon        = Drive-harddisk.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Path et url]]
 +
|description = Les API bab_Path et bab_url pour gérer les chemins et les adresses
 +
|icon        = Applications-utilities.png
 +
}}
 +
{{MenuItem
 +
|title      = [[API du gestionnaire de fichiers]]
 +
|description = Document à compléter
 +
|icon        = Fs-directory.png
 +
}}
  
Cette version d'Eclipse est disponible sur la [http://download.eclipse.org/tools/pdt/downloads/ page de téléchargement du projet PDT] :
+
</div>
* choisir le lien de la dernière version ''Release Build'',
+
<div class="bg-bloc bg-green">
* télécharger la version ''all-in-one'' pour la plateforme voulue (unix, windows ou macosx),
+
* décompresser l'archive,
+
* lancer le fichier exécutable eclipse dans le répertoire qui vient d'être créé.
+
  
====Récupération du noyau d'Ovidentia====
+
=== Documentation des librairies partagées ===
Nous allons créer un projet ovidentia qui contiendra la dernière version CVS du noyau d'Ovidentia.
+
  
1. Dans le menu sélectionner '''File > New > Project...'''
+
{{MenuItem
 +
|title      = [[API des fonctionnalités]] et [[API du gestionnaire d'événement]]
 +
|description = APIs pour créer des bibliothèques de code partagé et faciliter la communication entre les modules.
  
[[Image:EclipsePDT New Project CVS.jpg|thumb|400px]]
+
Voir aussi : [[:Catégorie:Documentation des librairies|Documentation des librairies]] ([[Widgets]], [[Object-Relational_Mapping|Orm]]...)
2. Dans la liste, sélectionner '''CVS > Projects from CVS'''
+
|icon        = Applications-accessories.png
 +
}}
  
puis '''Next >'''
 
  
<br style="clear: both" />
+
</div>
  
 +
||
 +
<div class="bg-bloc bg-grey">
  
[[Image:EclipsePDT Checkout from CVS.jpg|thumb|400px]]
+
=== Documentation interne ===
3. Sélectionner '''Create a new repository location'''
+
  
puis '''Next >'''
+
{{MenuItem
 +
|title      = [[Moteur de templates]]
 +
|description = Explication du fonctionnement de la fonction ''bab_printTemplate()''
 +
|icon        = Screen.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Authentification par identifiant NT]]
 +
|description = Fonctionnement de l'authentification par NTML
 +
|icon        = Keys.png
 +
}}
 +
{{MenuItem
 +
|title      = Outils de développements
 +
|description = [https://bitbucket.org/cantico/ Bitbucket], [[Eclipse]], [[Scripts]]
 +
|icon        = Applications-accessories.png
 +
}}
 +
{{MenuItem
 +
|title      = Structures des tables de données d'Ovidentia
 +
|description = [[Structures des tables de données d'Ovidentia]]
 +
|icon        = db_status.png
 +
}}
  
Cette étape va nous permettre de définir l'accès au dépôt CVS d'Ovidentia. Cette configuration pourra être utilisée par la suite pour d'autres projets.
+
</div>
 +
<div class="bg-bloc">
  
<br style="clear: both" />
+
=== Propositions d'améliorations ===
  
 +
{{MenuItem
 +
|title      = Propositions des utilisateurs
 +
|description = Articles qui décrivent les propositions d'améliorations soumises par les utilisateurs
 +
* [[Articles]]
 +
* [[Gestionnaire de fichiers]]
 +
* [[Propositions pour Ovidentia 7]]
 +
* [[Utilisateurs]]
 +
* [[Internationalisation]] : Améliorations de la gestion de l'internationalisation dans Ovidentia
 +
* [[Outils de maintenance]]
 +
|icon        = Dialog-information.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Refactorisation du noyau]]
 +
|description = Remplacer des parties du codes existantes afin d'améliorer Ovidentia
 +
* [[Gestion des skins]]
 +
* [[Délégations]] : Refonte de la gestion des délégations dans Ovidentia
 +
|icon        = Code-clear.png
 +
}}
 +
{{MenuItem
 +
|title      = [[Sitemap|Sitemap : plan du site]]
 +
|description = Documentations et spécifications du futur plan du site dans Ovidentia, voir aussi : [[Gestion des nœuds du plan du site]]
 +
|icon        = Applications-utilities.png
 +
}}
  
[[Image:EclipsePDT Checkout from CVS 1.jpg|thumb|400px]]
+
</div>
4. Saisir les information concernant le dépôt CVS :<br />
+
<div class="bg-bloc bg-violet">
''Host'': '''cvs.ovidentia.org'''<br />
+
''Repository path'': '''/home/src/public'''<br />
+
''User'': '''anonymous'''<br />
+
''Password'':<br />
+
''Connection type'': '''pserver''' et '''Use default port'''<br />
+
  
puis '''Next >'''
+
=== Règles de développement ===
  
Nous configurons ici un simple accès anonyme à CVS qui nous permettra d'accéder au noyau et aux modules publics. Un accès anonyme ne donne cependant pas la possibilité de faire de ''commit''.
+
{{MenuItem
Si vous disposez d'un compte sur le serveur CVS il faut utiliser les paramètres suivants :
+
|title      = [[Règles de codage]]
 
+
|description = Règles établies pour le développement du noyau d'Ovidentia
''Host'': '''cvs.ovidentia.org'''<br />
+
* [[Accessibilité]]
''Repository path'': '''/home/src/public'''<br />
+
* [[Sécurité]]
''User'': '''mon_login'''<br />
+
* [[PHPDoc|Commenter son code]]
''Password'':<br />
+
* [[Développement d'une nouvelle fonctionnalité]]
''Connection type'': '''extssh''' et '''Use default port'''<br />
+
|icon        = Applications-development.png
 
+
}}
<br style="clear: both" />
+
{{MenuItem
 
+
|title      = [[Utilisation de Mantis]]
 
+
|description = Gestion des bugs
[[Image:EclipsePDT Check Out As.jpg|thumb|400px]]
+
|icon        = Bug-buddy.png
5. Sélectionner '''Check out as project configured using the New Project Wizard'''
+
}}
 
+
{{MenuItem
puis '''Next >'''
+
|title      = [[Utilisation de GIT]]
 
+
|description = Gestion des versions dans git et [[Développement d'un programme de mise à jour]]
Cette étape va nous permettre définir le type de projet que nous créons (projet PHP).
+
|icon        = Fs-directory.png
 
+
}}
<br style="clear: both" />
+
  {{MenuItem
 
+
|title      = [[Code de caractère]]
 
+
|description = Gestion des encodages dans ovidentia et conversion de latin1 à utf8
[[Image:EclipsePDT Check Out As 1.jpg|thumb|400px]]
+
|icon        = Configure.png
6. Sélectionner '''HEAD''' dans la liste
+
}}
 
+
puis '''Finish'''
+
 
 
+
</div>
HEAD est la branche en cours de développement du noyau.
+
 
+
<br style="clear: both" />
+
 
+
 
+
[[Image:EclipsePDT New Project PHP.jpg|thumb|400px]]
+
7. Sélectionner '''PHP Project''' dans la liste
+
 
+
puis '''Next >'''
+
 
+
Cette étape permet de spécifier à Eclipse que le projet est un projet PHP. Tous les outils seront donc configurés en conséquence lorsque l'on travaillera sur ce projet.
+
 
+
<br style="clear: both" />
+
 
+
 
+
[[Image:EclipsePDT PHP Project .jpg|thumb|400px]]
+
8. Saisir le nom du projet dans la case '''Project Name''', par exemple '''ovidentia_head'''.
+
 
+
puis '''Finish'''
+
<br style="clear: both" />
+
 
+
=== Technologies à l'étude ===
+
 
+
* [[SyncML]]
+
* [[CardSpace]]
+
* [[WebDAV]]
+
* [[Plugins OpenSearch]]
+
* [[Communication entre les modules]]
+
* [[Les microformats]]
+
* [[Le standard UWA de Netvibes]]
+
 
+
=== Améliorations Ovidentia ===
+
 
+
* [[Gestionnaire de fichiers]]
+
* [[Propositions pour Ovidentia 7]]
+
* [[OVML]]
+
  
 
|}
 
|}
 
 
  
 
== Utilisation du wiki ==
 
== Utilisation du wiki ==
  
 
Consultez le [http://meta.wikimedia.org/wiki/Aide:Contenu Guide de l'utilisateur] pour plus d'information sur l'utilisation d'un wiki.
 
Consultez le [http://meta.wikimedia.org/wiki/Aide:Contenu Guide de l'utilisateur] pour plus d'information sur l'utilisation d'un wiki.
 
* [http://www.mediawiki.org/wiki/Manual:Configuration_settings/fr Liste des paramètres de configuration]
 
* [http://www.mediawiki.org/wiki/Manual:FAQ/fr FAQ MediaWiki]
 
 
En anglais :
 
* [http://mail.wikipedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
 
  
 
__NOTOC__
 
__NOTOC__

Version actuelle en date du 27 juillet 2016 à 14:52

Documentations et références Ovidentia


Bienvenue sur le site dédié à la documentation et aux références Ovidentia.

Pour télécharger des documentations utilisateur et administrateur pour OVIDENTIA, vous pouvez utiliser le site communautaire Ovidentia.org.

Avant de contribuer, vous pouvez vous familiariser avec les règles d'usage du wiki et l'aide à l'écriture Mediawiki.

Le développement d'OVIDENTIA est initié et géré par logo cantico Cantico


Administration

Maintenance

Intégration

Skins


Comment développer ou modifier des skins pour le portail.

Développement

Cette partie contient une introduction au développement des modules ainsi que diverses documentations sur les nouvelles interfaces de programmation disponibles dans les versions actuelles et futures d'OVIDENTIA.

Le développement d'OVIDENTIA est initié et géré par logo cantico Cantico

Documentation des API du noyau


Contenu de l'API Ovidentia. Ces API peuvent être utilisées dans le cadre du développement de modules.

Documentation des librairies partagées


Documentation interne

Propositions d'améliorations

Règles de développement


Utilisation du wiki

Consultez le Guide de l'utilisateur pour plus d'information sur l'utilisation d'un wiki.