Toon posts:

[XML] Wat is de beste indeling?

Pagina: 1
Acties:

Verwijderd

Topicstarter
Ik ben nu bezig mijn WYSIWYG Editor te herprogrammeren voor Gecko 1.0+ en IE Browsers. De editor krijgt een API waardoor het eenvoudig wordt Extensions te maken voor de Editor.
Wat is nu de bedoeling. De resources (afbeeldingen, stylesheets, xml bestanden) worden met behulp van een parameter opgegeven. Nu wil ik in de map $resources$/Extensions/ alle Extensions voor de Editor bijhouden. In die map moet dus een XML Bestand komen die tijdens het laden van de Editor geladen wordt. In dat bestand kan men Extensions zetten. Die Extensions komen in een apart menu (windows look-a-like, net zoals het menu onder Bestand in je browser) te staan. Wanneer op Extensions geklikt wordt, wordt voor alle Extensions gekeken of de Extensie uitgevoerd (enabled) of niet uitgevoerd (disabled) kan worden.
Nu moet dit dus opgegeven worden in het XML bestand. Maar aangezien er de afgelopen tijd nogal hevige discussies zijn geweest over semantische correctheid en schoonheid van code vraag ik jullie wat netter is qua indeling. Dit formaat had ik in gedachten

code:
1
2
3
4
5
6
7
8
9
10
11
<command>
  <title>Change Case</title>
  <summary>Change the case of the selected text</summary>
  <canacceptcommand>
    var dom = nextavenue.getDocumentDOM();
    var html = nextavenue.getHtmlFromRange();
    // Als html empty is, is er geen HTML geselecteerd en moet de Extensie disabled zijn
    ret = (html == "");
  </canacceptcommand>
  <gui src="change_case.htm" />
</command>

Nu kan dit ook op een mooie one-liner:
code:
1
2
3
4
5
6
<command title="foo" summary="foo" src="change_case.htm">
    var dom = nextavenue.getDocumentDOM();
    var html = nextavenue.getHtmlFromRange();
    // Als html empty is, is er geen HTML geselecteerd en moet de Extensie disabled zijn
    ret = (html == "");
</command>


Maar nu de vraag: wat is beter? Wat is mooier? Waar zouden jullie voor kiezen? Denk er dan ook daan dat het mogelijk is dat er een twintigtal Extensions zullen zijn... Gaan voor de korte variant of toch de beter leesbare langere?

[ Voor 12% gewijzigd door Verwijderd op 16-03-2004 22:17 ]


Verwijderd

de eerste, content hoort als element, metadata als attribuut. Nu is vaak de vraag wat metadata is en wat content is. Jouw eerste voorbeeld geeft al meteen aan dat een src ergens van "voelt" als metadata, die heb je dus ook als attribuut opgenomen (dus niet <gui><src>change_case.htm</src></gui>)

title en summary zijn dingen die uiteindelijk in van belang zijn voor het begrip van de content, deze zou ik dus in elementen houden (het voelt als content)

samengevat: eerste dus

  • SKiLLa
  • Registratie: Februari 2002
  • Niet online

SKiLLa

Byte or nibble a bit ?

Mophor heeft helemaal gelijk !

Zie bv: http://www.w3schools.com/xml/xml_attributes.asp
Of http://lists.xml.org/archives/xml-dev/200009/msg00039.html
(en dan vooral de follow-up's).

Het blijft natuurlijk altijd een kwestie van style & interpretatie, maar ook
afhankelijk van de toepassing waarvoor je de XML gebruikt.
Ookal is de 2e notatie korter, ik zou ook voor de 1ste notatie gaan.

'Political Correctness is fascism pretending to be good manners.' - George Carlin