MODX

Uit phpBB.nl Wiki
Ga naar: navigatie, zoeken
Dit artikel is mogelijk gedateerd, bevat onvoldoende uitleg of moet worden herschreven. Mocht u zich geroepen voelen om het artikel te herzien kies dan voor bewerk. Alvast bedankt!. W-icoon.gif

MODX is een nieuw MOD formaat ontwikkeld door het phpBB MOD Team met de achterliggende gedachte om het installeren en het maken van MODs gemakkelijker te maken voor zowel MOD auteurs als doorsnee phpBB gebruikers. Het formaat is geschreven in XML, zodat MOD auteurs gemakkelijk aanpassingen kunnen maken, en normale gebruikers het in hun browser kunnen openen door middel van XSL Transformaties. Ook zorgt MODX voor een nieuwe standaard distributie van MODs.

Verbeteringen sinds het text template

Omdat MODX in XML is geschreven is het, in tegenstelling tot het verouderde text template, niet gebonden aan platform of taal. Met behulp van XSL Styling is de MOD installatie overzichtelijk te bekijken in de meeste nieuwe browsers. XML parsing is ook al breed geaccepteerd door belangrijke webtechnologieën zoals PHP en ASP.NET.

Mensen die een mod instaleren kunnen zo gemakkelijker zien wat ze moeten doen om de modificatie aan de praat te krijgen. Om dit makkelijker en overzichtelijker te maken voor de eind gebruiker, is modX uitgevonden.

In tegenstelling tot phpBB3 modificatie instalaties hadden we tekst met vaak verwarende teksten en opdrachten. In modX is alles een stuk overzichtelijker en heb je minder kans op fouten en problemen.

Distributie Standaard

MODX brengt een nieuwe standaard met zich mee voor het verpakken van MODs. Alle MODs moeten zich, net als in het text template, houden aan het phpBB Versie Systeem. Alle MODs moeten in tot een .zip formaat worden gecomprimeerd en moeten bestaan uit een nieuwe mappen structuur.

/ -root/ -contrib/ -languages/ -templates/

De meest bovenliggende map

De meest bovenliggende map bevat het MODX .xml installatiebestand, het MODX .xsl stylesheet en optioneel een licentie met de naam license.txt. Het .xml installatiebestand mag alleen aanpassingen bevatten voor de PHP bestanden, de standaard taal (Brits Engels), en de standaard style (subSilver voor phpBB2, prosilver voor phpBB3).

De /root map

De /root map representeert de root map van een phpBB installatie. Bijgeleverde bestanden van de MOD staan in deze map, in exact dezelfde structuur waarin ze gekopieërd worden naar de phpBB map van de gebruiker.

Meestal vind je hier de install.xml, dit bestand moet je simpel in je browser openen, en dus niet naar je server kopieren. In dit bestand bevind zich alle instructies die nodig zijn om de modificatie naar te keuze te instaleren.

De /languages map

De /languages map bevat alle aanpassingen voor extra talen. Elke extra taal heeft zijn eigen MODX bestand met de naam van de desbetreffende taal.

De /templates map

De /templates map bevat alle aanpassingen voor extra templates. Elk extra template heeft zijn eigen MODX bestand met de naam van het desbetreffende template.

De /contrib map

Contrib staat voor contributies. De /contrib map bevat alle bestand upgrades van verschillende versies van de desbetreffende MOD naar de nieuwste versie, installatie compatibiliteit met andere MODS, of andere bestanden die de auteur bij zou willen sluiten. Ook kan je hier het alternatieve text template bijsluiten. Hierin mogen géén premodded bestanden staan. Dit kan bij sommige mensen zorgen voor incompatibiliteit met andere geinstalleerde MODs.

Het schrijven van MODX

Tag lijst

Tag Beschrijving Aantal keren Dochters
<header> De header bevat alle meta data van de MOD. Alle velden bevatten tekst in de ISO 639 taalcode. Één keer title, description, author-notes, author-group, mod-version, installation, history,

meta.

<title> De titel van de MOD. Één keer voor elke taal. (minimaal één keer) geen.
<description> De beschrijving van de MOD. Één keer voor elke taal. (minimaal één keer) geen.
<author-notes> Extra opmerkingen van de MOD auteur. Één keer voor elke taal. (minimaal één keer) geen.
<author-group> Bevat een lijst met auteurs die gewerkt hebben aan de MOD. Één keer. author.
<author> Bevat contact informatie van de auteur. Minimaal één keer. realname, email, username, homepage, contributions.
<realname> Bevat de echte naam van de auteur. Één keer per <author> tag.(kan ook leeg gelaten worden) geen.
<email> Bevat het email adres van de auteur. Één keer per <author> tag.(kan ook leeg gelaten worden) geen.
<username> Bevat de gebruikersnaam van de auteur op de plaats waar de MOD is uitgebracht. Één keer per <author> tag.(kan ook leeg gelaten worden) geen.
<homepage> Bevat de website van de auteur. Één keer per <author> tag.(kan ook leeg gelaten worden) geen.
<contributions> Bevat de contributies van de auteur. Ook kan er aangegeven worden of de auteur de vorige, of meest recente ontwikkelaar is. Één keer per <author> tag.(kan ook leeg gelaten worden) geen.
<mod-version> Bevat de versie van de MOD. Het uiteindelijke resultaat is “X.Y.Za”, oftewel “Major.Minor.RevisionRelease”. Één keer. major, minor, revision, release
<major> Bevat de Major versie van de MOD. De Major versie is X in het X.Y.Za versie formaat. Één keer. geen.
<minor> Bevat de Minor versie van de MOD. De Minor versie is Y in het X.Y.Za versie formaat. Één keer. geen.
<revision> Bevat de Revision versie van de MOD. De Revision versie is Z in het X.Y.Za versie formaat. Één keer. geen.
<release> Bevat de Release versie van de MOD. De Release versie is a in het X.Y.Za versie formaat. Één keer. geen.
Snel meer...