[XML] style guide voor XML?

[Alarmnummer]

Waar kan ik 'de' style guide vinden voor XML? Ben anders beetje bang dat ik mijn eigen stijl ga ontwikkelen

[Verwijderd]

Begin hier http://www.w3.org/XML/ eens te zoeken. helpt je wellicht verder.

[tomato]

Euh... ik begrijp niet goed wat je precies bedoelt

Doel je op opmaak, naamgeving, structuur, of iets anders

[Alarmnummer]

Ik bedoel met een style guide wat met java ook met een style guide wordt bedoelt. Naamgeving, enters tabs /atrubuur of element/etc etc. Alle dingen die een xml bestand beter leesbaar maken.

[Alarmnummer]

Bij grotere geneste element structeren zorg ik ervoor dat er in belangrijke kop elementen wel een attribuut zit waaraan ik de betekenis kan afleiden van het gene wat erin zit. Anders wordt een XML snel minder goed leesbaar. Ik zet er op dit moment ook regelmatig een extra enter in om het allemaal wat te scheiden. Maar ik werk liever volgens een standaard..

[tomato]

Is er niet voor zover ik weet.

Houd duidelijke beschrijvende namen aan (geen afkortingen). Gebruik zoveel mogelijk indenting in je tree en newline na iedere node.

Dat is wat ik meestal toch doe, maar het ligt ook maar aan de situatie. Bij een configuratiebestandje dat vanuit een applicatie gebruikt wordt maakt het natuurlijk niet zoveel uit hoeveel enters of tabs ertussen staan.

[tomato]

Alarmnummer: Bij grotere geneste element structeren zorg ik ervoor dat er in belangrijke kop elementen wel een attribuut zit waaraan ik de betekenis kan afleiden van het gene wat erin zit.

Eigenlijk zou je dat al moeten kunnen afleiden aan de element naamgeving...

[Alarmnummer]

Op donderdag 21 februari 2002 10:39 schreef tomato het volgende:

[..]

Eigenlijk zou je dat al moeten kunnen afleiden aan de element naamgeving...

Daaruit kan je de klasse afleiden maar niet de instantie.

vb van wat ik doe:

code:

<land naam="nederland">
   <inwoners>1000</inwoners>
</land>

ipv

code:

<land>
   <naam>nederland</naam>
   <inwoners>1000</inwoners>
</land>

Vooral als je veel kinder elementen heb dan kan het soms wel eens vervelend worden om uit te vinden welke instantie je nog maar bedoelt.

[tomato]

Alarmnummer: Daaruit kan je de klasse afleiden maar niet de instantie.

Klopt, ik dacht dat je daar op doelde

vb van wat ik doe:

code:

<land naam="nederland">
   <inwoners>1000</inwoners>
</land>

ipv

code:

<land>
   <naam>nederland</naam>
   <inwoners>1000</inwoners>
</land>

Hmmm, lijkt me nogal ver gaan om om die reden attributes ipv elements te gebruiken. Liever zie ik eigenlijk helemaal geen attributes.
Bij grotere structuren gebruik je waarschijnlijk toch XPath om bepaalde instanties te zoeken, dan heb je niets aan deze 'methode' (en is het ook niet nodig).

Vooral als je veel kinder elementen heb dan kan het soms wel eens vervelend worden om uit te vinden welke instantie je nog maar bedoelt.

Ik zou dan niet verder gaan dan voor jezelf de belangrijkste elements bovenaan te zetten:

code:

<land>
   <naam>nederland</naam>
   <inwoners>1000</inwoners>
</land>

ipv

code:

<land>
   <inwoners>1000</inwoners>
   <naam>nederland</naam>
</land>

[tomato]

Je moet je misschien niet te veel bezig houden met de presentatie in XML formaat, dat hoort absoluut niet van belang te zijn. Ik snap dat het voor jou als developer makkelijk is wanneer je snel een bepaald land kunt vinden, maar om dat goed te presenteren hebben we eigenlijk andere formaten en transformatietalen

Ook vind ik dat je bij grotere structuren maar niet te veel 'handmatig met notepad' moet gaan zitten rotzooien. Simpele configurtieschermpjes waar het XML bestand achter zit zijn erg snel gemaakt met alle bestaande tools.

[Alarmnummer]

Op donderdag 21 februari 2002 10:53 schreef tomato het volgende:

Hmmm, lijkt me nogal ver gaan om om die reden attributes ipv elements te gebruiken. Liever zie ik eigenlijk helemaal geen attributes.
Bij grotere structuren gebruik je waarschijnlijk toch XPath om bepaalde instanties te zoeken, dan heb je niets aan deze 'methode' (en is het ook niet nodig).

Ik gebruik op dit moment totaal geen XPath om in te lezen. Ik schrijf een paar zichzelf afhandelende methodes en het is ongelovelijk recht toe recht aan werk. En ik kan perfect alle elementen met elkaar linken als ik het pad van de boom blijf volgens ipv stukker naar boven te halen.

Maar het gaat mijn voornamelijk om degene die de XML bestanden moet bewerken. Ik gebruik op dit moment oa XML om een GUI op te bouwen (programma verloop te bepalen). Dit bevalt me uistekend omdat ik een generieke oplossing maak en ik me niet bezig hoef te houden met de invulling. Maar degene die de XML bestanden bewerkt die moet het niet veel tijd gaan kosten om uit te vinden in welke submenu of menuitem hij zit. Vandaar dat ik bij de kop van iedere submenu/menuItem de beschrijving zet.

vb

code:

    <subMenu label="hoofdMenu">
        <image>file:Folder.gif</image>
        <toolTipText>hoofd menu</toolTipText>
        <children>
            <innerLinkMenuItem label="help">
                <image>file:endUserGuiConfig/Help.gif</image>
                <toolTipText>algemene help over het mooie lawgame project</toolTipText>
                <href>file:endUserGuiConfig/ReadMe.htm</href>
                <title>Algemene help over het Law Game spel</title>
            </innerLinkMenuItem>
            
            <outerLinkMenuItem label="help in explorer">
                <image>file:endUserGuiConfig/Help.gif</image>
                <toolTipText>algemene help over het mooie lawgame project</toolTipText>
                <href>http://www.lawgame.com/index.htm</href>
            </outerLinkMenuItem>
            <outerLinkMenuItem label="lawgame forum">
                <image>file:endUserGuiConfig/OuterLink.png</image>
                <toolTipText>Ga naar lawgame forum</toolTipText>
                <href>http://www.lawgame.com/index.htm</href>
            </outerLinkMenuItem>
            <outerLinkMenuItem label="chatbox">
                <image>file:endUserGuiConfig/OuterLink.png</image>
                <toolTipText>Ga naar lawgame chatbox</toolTipText>
                <href>http://www.lawgame.com/index.htm</href>
            </outerLinkMenuItem>
            <subMenu label="kies casus">
                <image>file:endUserGuiConfig/Folder.gif</image>
                <toolTipText>hiermee kan tussen verschillende casus gekozen worden</toolTipText>
                <children>
                    <subMenu label="erfrecht">
                        <image>file:endUserGuiConfig/ErfRecht.gif</image>
                        <toolTipText>wie er dood is gegaan en wie er dood gaat</toolTipText>
                        <children>
                            <subMenu label="gegevens bekijken">
                                <image>file:endUserGuiConfig/Folder.gif</image>
                                <toolTipText>gegevens uit tabellen bekijken</toolTipText>
                                <children>
                                    <subMenu label="hierarchisch">
                                        <image>file:endUserGuiConfig/Folder.gif</image>
                                        <toolTipText>gegevens uit tabellen bekijken</toolTipText>