Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
doc:xml_projects_0.1 [16/02/2009 22:07]
127.0.0.1 édition externe
doc:xml_projects_0.1 [20/11/2014 13:02] (Version actuelle)
Ligne 1: Ligne 1:
 +====== La structure XML utilisée pour décrire les schémas dans QElectroTech 0.1 ======
  
 +===== Exemple de schéma électrique =====
 +
 +{{diagram_example0.png|Exemple de schéma QET}}
 +
 +Le schéma ci-dessus peut être obtenu avec le code XML suivant : [[documentation_xml_schemas_exemple|voir le code XML de ce schéma]].
 +===== Projet =====
 +
 +Tout en haut de l'​arborescence XML, on trouve l'​élément racine "​project"​. Les fichiers *.qet ne contiennent pour le moment qu'un seul schéma. Mais à partir de la version 0.2, ils pourront contenir plusieurs schémas et éléments.
 +
 +L'​élément XML "​project"​ accepte l'​attribut "​version"​ qui doit contenir la version de QElectroTech ayant enregistré le fichier. Cela servira à faciliter la rétro-compatibilité ultérieurement en cas de changement de format.
 +
 +===== Schéma =====
 +
 +Sous le projet, on retrouve un schéma sous la forme de l'​élément XML "​diagram"​. Celui-ci accepte différents attributs.
 +
 +==== Attributs relatifs au cartouche ====
 +
 +Les attributs suivants servent à remplir le cartouche du schéma :
 +
 +  * title : titre affiché dans le cartouche
 +  * author : auteur affiché dans le cartouche
 +  * date : date au format AAAAMMJJ, affichée dans le cartouche
 +  * filename : nom de fichier affiché dans le cartouche. Cette valeur est strictement indépendante du fichier contenant le XML.
 +  * folio : Valeur affichée dans le cartouche. Cette valeur est strictement indépendante de l'​impression,​ de la mise en page ou du nombre de schémas dans le projet.
 +
 +==== Attributs relatifs aux dimensions du schéma ====
 +
 +Les attributs suivants influent sur les dimensions du schéma :
 +
 +  * cols : nombre de colonnes
 +  * colsize : largeur des colonnes, en pixels
 +  * height : hauteur du schéma, en pixels
 +
 +L'​élément XML "​diagram"​ accueille ensuite quatre autres éléments : les propriétés des conducteurs par défaut, les éléments, les conducteurs et les champs de texte.
 +
 +===== Propriétés des conducteurs par défaut =====
 +
 +L'​élément XML "​defaultconductor"​ permet de spécifier le type de conducteurs par défaut pour ce schéma. En effet, lorsqu'​on travaille sur un schéma, on n'​utilise généralement qu'un seul type de conducteur, avec des propriétés bien définies. Il est alors fastidieux de respécifier pour chaque nouveau conducteur qu'il doit être de tel type, avec telles propriétés,​ etc. À noter que ceci n'​influence absolument pas le rendu du schéma, il s'agit seulement d'une indication pour faciliter les manipulations dans l'​éditeur WYSIWYG de QElectroTech.
 +
 +Les conducteurs peuvent être de trois types : simples ("​simple"​),​ unifilaires ("​single"​) ou multifilaires ("​multi"​). Un conducteur multifilaire possède un champ de texte permettant de le numéroter. Un conducteur unifilaire ne possède pas de champ de texte mais arbore des symboles permettant de déterminer les fils qu'il représente. Un conducteur simple n'a ni symbole ni champ de texte.
 +
 +L'​élément XML "​defaultconductor"​ accepte l'​attribut "​type"​ pour définir le type de conducteur. Si type vaut "​simple",​ les autres attributs seront ignorés. Si type vaut "​multi",​ le champ de texte contiendra la valeur de l'​attribut "​num"​. Si type vaut "​single",​ le conducteur arborera :
 +
 +  * le symbole neutre si l'​attribut "​neutral"​ vaut "​true"​
 +  * le symbole terre si l'​attribut "​ground"​ vaut "​true"​
 +  * 0 à 3 symbole(s) phase selon la valeur de l'​attribut "​phase"​ : 0, 1, 2 ou 3
 +===== Éléments =====
 +
 +L'​attribut XML "​elements"​ regroupe la liste des éléments électriques qui apparaissent sur le schéma. Chaque élément XML "​element"​ (ça y est, on va commencer à s'​embrouiller) accepte les attributs suivants :
 +
 +  * x : abscisse de la position de l'​élément
 +  * y : ordonnée de la position de l'​élément
 +  * type : il s'agit de l'​adresse virtuelle de la définition de l'​élément à placer sur le schéma
 +  * orientation : 0 (Nord), 1 (Est), 2 (Sud), 3 (Ouest)
 +
 +Concernant le positionnement de l'​élément,​ il s'agit de la position du "​hotspot"​ (point de saisie) de l'​élément,​ et non de son coin supérieur gauche ou de son barycentre. Cette position est donnée dans un repère orthonormal dont l'​origine est situé en haut à droite de la fenêtre d'​édition (pour information,​ le coin supérieur gauche du schéma est situé à 5px,5px), dont le vecteur x se dirige vers la droite et dont le vecteur y se dirige vers le bas.
 +
 +Les adresses virtuelles commencent par %%common://​%% pour désigner un élément de la collection commune ou par custom:// pour désigner un élément de la collection de l'​utilisateur. À partir de la version 0.2, il y aura également embed:// pour désigner un élément embarqué dans le projet.
 +
 +À l'​intérieur de chaque élément XML "​element",​ on peut trouver :
 +
 +  * des bornes (éléments XML "​terminal"​) encapsulées dans un élément XML "​terminals"​
 +  * des champs de texte (éléments XML "​input"​) encapsulés dans un élément XML "​inputs"​
 +
 +==== Bornes ====
 +
 +Comme dans la définition d'un élément, une borne est définie par l'​attribut XML "​terminal"​ et exige les attributs "​x",​ "​y"​ et "​orientation"​ **dans les coordonnées de l'​élément**. Ces attributs sont utilisés pour repérer la borne correspondante dans l'​élément. L'​attribut id permet de retrouver cette borne parmi toutes celles apparaissant sur le schéma. Il s'agit d'un entier positif. Il est impossible de relier un conducteur à une borne sans id. De même, il est impossible d'​ajouter une borne à un élément sans éditer cet élément.
 +
 +==== Champs de texte ====
 +
 +Comme les bornes, les champs de texte (éléments XML "​input"​) exigent les attributs "​x"​ et "​y"​ **dans les coordonnées de l'​élément** afin de repérer le champ de texte correspondant dans l'​élément. Il n'est pas non plus possible d'​ajouter un champ de texte non prévu dans la définition de l'​élément. Le champ de texte ainsi repéré se verra attribué la valeur de l'​attribut "​text"​.
 +
 +===== Conducteurs =====
 +
 +Encapsulés dans l'​élément XML "​conductors",​ les conducteurs sont représentés par des éléments XML "​conductor"​ (si !). Ils acceptent les mêmes attributs que l'​élément XML "​default conductor"​ pour définir leur type et leurs options. À cela s'​ajoutent les attributs "​terminal1"​ et "​terminal2"​ qui doivent avoir pour valeur les ids des bornes que le conducteur relie.
 +
 +Un conducteur est optionnellement composé de segments ( = éléments XML "​segment",​ si, si !) décrivant sa trajectoire. Si aucun segment n'est présent ou que la trajectoire décrite est incohérente,​ le logiciel repasse sur le trajet par défaut pour relier les deux bornes.
 +
 +Un segment possède un attribut "​orientation"​ qui peut prendre les valeurs "​horizontal"​ ou "​vertical"​ pour définir le sens du segment. Il possède également un attribut length définissant sa longueur. Les segments sont lus dans l'​ordre et représentent la trajectoire de la borne 1 vers la borne 2.
 +
 +===== Champs de texte indépendants sur le schéma =====
 +
 +Encapsulés dans l'​élément XML "​inputs"​ situé sous l'​élément XML "​diagram",​ les champs de texte sont représentés par des éléments XML (suspens...) "​input"​ (vous avez eu peur hein ?). Contrairement aux "​inputs"​ des éléments ou au "​num"​ des conducteurs multifilaires,​ ils ne sont pas liés à un conducteur ou un élément et peuvent être positionnés librement sur le schéma.
 +
 +L'​élément XML "​input"​ accepte les attributs suivants :
 +
 +  * x : abscisse du coin supérieur gauche du champ de texte
 +  * y : ordonnée du coin supérieur gauche du champ de texte
 +  * text : contenu du champ de texte - utilisez 
 pour faire un retour à la ligne.
Imprimer/exporter
Langages