Elxisitalia.com!
Il portale sull'open source Elxis CMS.

italian english

Come realizzare un file XML per l'installazione dei moduli in Elxis CMS

Email

Elxis installer usa files XML per prendere le informazioni dell’estensione che deve installare e quail file il pacchetto d’installazione della estensione contiene. Questi files XML anche usati per fornirvi i parametri per le vostre personalizzazioni e sul come lavora l’estensione (XML parameters). Ogni tipo di estensione (componenti, moduli, templates, etc.) ha file XML leggermente diversi l’una dall’altra.

Codifica di default e tipo di installazione.

Tutti i files XML di default devono essere codificati in UTF-8. Potete fare questo nell’header del vostro file:
<?xml version="1.0" encoding="utf-8"?>
Fatto questo dovremo dire ad Elxis il  tipo di installazione del pacchetto pacchetto ovvero: module, component, mambot, bridge, tool, language e tamplate.

In questa guida vi mostreremo come creare un pacchetto per i moduli (module type).
Alcune estensioni hanno un tipo di modulo chiamato “Client”. Il “Module” è uno di loro.
L’attributo del client in un modulo dichiara se è un modulo front-end o back-end ( amministrativo). Per i moduli l’attributo client dovrebbe essere dichiarato solo se il modulo è per Elxis CMS back-end! In caso contrario il valore client deve essere vuoto oppure non va settato. Se il modulo per Elxis deve essere usato per il lato amministrativo (back-end) il valore sarà:
client=”administrator”
Nella stessa linea dovrà essere dichiarata anche la versione Elxis CMS oppure l’estensione per quale generazione di Elxis è stata sviluppata.
<mosinstall type="module" version="2008">
Attenzione: questa non deve essere la versione della vostra estensione ma per quale versione di Elxis. Elxis 2008.0+ durante l’installazione vi notificherà se il pacchetto è per una versione precedente di Elxis CMS oppure l’estensione appartiene a un altro CMS (es. joomla, mambo, etc etc.)

XML headers.

A questo punto si scriveranno alcune informazioni generali del modulo:

  • name: Nome dell’estensione
  • author: Chi ha creato l’estensione (nome o compagnia)
  • licence: Licenza sotto la quale è stata creata (GNU/GPL, GNU/LGPL, CC, Commercial, etc)
  • copyright (optional): Il copyright dell’estensione. Esempio: (C) 2006-2008 Elxis.org. All rights reserved
  • creationDate: La data esatta di creazione e deve essere in questo YYYY-mm-dd HH:ii:ss (Anno-Mese-Giorno Ora:Minuti:Secondi) Elxis automaticamente convertirà la data a seconda della lingua settata di default. (lato amministrativo)
  • authorEmail: Indirizzo e-mail dell’autore.
  • authorUrl: Indirizzo http del sito web dell’autore
  • cxlangdir (optional): La path relativa alla directory della lingua personalizzata in XML secondo i parametri standard Elxis. Esempio: /modules/mod_mysupermodule/language
  • version: La versione della vostra estensione (no versione Elxis). Vi avvisiamo che deve sempre partire da 0.1 per le versioni beta e da 1.0 per le versioni stabili.
  • description: Un breve descrizione della vostra estensione. Se desiderate potete usare una costante CX_ per i vostri file lingua o CDATA da scrivere in HTML

A questo punto un esempio di come sarà l’intestazione della vostra estensione

<name>Miomodulo</name>
<author>Elxis Team</author>
<licence>GNU/GPL</licence>
<copyright>(C) 2006-2008 Elxis.org. All rights reserved</copyright>
<creationDate>2008-01-18 20:36:15</creationDate>
<authorEmail> </authorEmail>
<authorUrl>http://www.elxis.org</authorUrl>
<cxlangdir>/modules/mod_ miomodulo /language</cxlangdir>
<version>1.0</version>
<description>This Super Module converts your site to a time machine!</description>

Files Module

Ora passeremo ai file che compongono il pacchetto di installazione.
I files dovranno essere elencati completi della loro path relativa. Come directory di base deve essere considerata la cartella che corrisponde al tipo di estensione. ( /modules per moduli front end ).
Il file modulo principale è dichiarato con l’attributo del modulo realizzato e deve avere come valore il nomefile senza l’estensione php. Per sicurezza usare files index.html vuoti nelle sottocartelle..

<files>
<filename module="mod_miomodulo">mod_miomodulo.php</filename>
<filename>nomefilenellacartella.php</filename>
<filename>mod_ miomodulo /index.html</filename>
<filename>mod_ miomodulo /readme.txt</filename>
<filename>mod_ miomodulo /javascript.js</filename>
<filename>mod_ miomodulo /language/index.html</filename>
<filename>mod_ miomodulo /language/english.php</filename>
<filename>mod_ miomodulo /language/italian.php</filename>
</files>

Moduli: parametri

Se il vostro modulo non ha nessun parametro (quasi tutti i moduli li hanno),
bisognerà inserire un singolo "<params />" nel file XML. Ogni parametro ha i seguenti attributi:

  • name: Nome parametro. Non inserire spazi. Es: moduleclass_sfx
  • type: Tipo delle’elemento HTML usato per accedere a questo parametro. Gli elementi validi sono: text, list, radio, textarea, mos_section, mos_category, mos_menu, imagelist and spacer.
  • label: Etichetta del parametro (multi-lingual).
  • description (optional): Visualizza un messaggio di aiuto per il completamento del parametro (multi-lingual)
  • dir (optional): La direzione del testo. Può essere settato “ltr” (left-to-right) o “rtl” (right-to-left). Di default il settaggio e LTR.
    Consiglio: Alcuni parametri XML, come indirizzi e-mail devono essere sempre LTR, così questi parametric dir=”ltr” devono essere sempre così anche in presenza di lingue .
  • default: Valore di default del parametro.


Examples:

<params>
<!--A text parameter using standard XML language (AX_) -->
<param name="moduleclass_sfx" type="text" dir="ltr" default="" label="AX_SM_MCSL" description="AX_SM_MCSD" />

<!--A list parameter using custom XML language (CX_) and RTL -->
<param name="cust_name" type="list" dir="rtl" default="2" label="CX_PPD_TIMDON" description="CX_PPD_TIMDOND">
<option value="0">CX_XXX_LS1</option>
<option value="1">CX_XXX_LS2</option>
<option value="2">CX_XXX_LS3</option>
</param>

<!--A radio parameter -->
<param name="cur_select" type="radio" default="0" label="Display welcome message?" description="">
<option value="0">AX_NO</option>
<option value="1">AX_YES</option>
</param>

<!--A textarea parameter, notice the cols and rows attributes -->
<param name="wecome_msg" type="textarea" dir="rtl" default="" label="AX_TTT_LEB" description="CX_YYY_DESC" cols="30" rows="5" />

<!--A spacer parameter, bold text or horizontal ruler -->
<param name="@spacer" type="spacer" default="Bold message" label="" description="" />

<!--A, imagelist parameter, notice the relative images directory -->
<param name="image1" type="imagelist" dir="ltr" directory="/images/M_images" default="" label="Select image" description="" />

Traduzione by Speck - Elxisitalia.com
Testi originali di Elxis.org

Sondaggi

Quali estensioni desideri?

Risultati

Accesso Utente





Non hai ancora un Profilo? Crea Profilo

Chi è online

Abbiamo 25 ospiti online
Valid XHTML 1.0 Transitional!
CSS Valido!
RSS 0.91
RSS 1.0
RSS 2.0
ATOM 0.3
OPML