Modulo:Message box/man

Wikibooks, manuali e libri di testo liberi.
Jump to navigation Jump to search

Questa è la pagina di documentazione per Modulo:Message box


Questo è il meta-modulo che implementa i template di avviso {{Mbox}}, {{Ambox}}, {{Cmbox}}, {{Fmbox}}, {{Imbox}}, {{Ombox}}, and {{Tmbox}}. Questo è stato progettato per essere usato dai moduli Lua, e non dovrebbe essere usato direttamente dalle pagine wiki. Se intendi utilizzare le funzionalità di questo modulo da una pagina wiki, per favore al suo posto usa il singolo template di avviso.

Uso[modifica]

Per poter caricare questo modulo da un altro modulo Lua, prima necessita di essere caricato.

local messageBox = require('Module:Message box')

Per creare un box di messaggio, usa la funzione main. Questa funzione ha due parametri, il primo è il tipo di stile del messaggio e il secondo è la tabella che contiene i parametri del box del messaggio.

local box = messageBox.main( boxType, {
    parametro1 = parametro1,
    parametro2 = parametro2,
    -- altri parametri...
})

Sono disponibili 7 tipi di messaggio:

Tipo Template Scopo
mbox {{Mbox}} Per i box dei messaggi usati in namesapace diversi
ambox {{Ambox}} Per i box dei messaggi usati nei lemmi
cmbox {{Cmbox}} Per i box dei messaggi usati nelle categorie
fmbox {{Fmbox}} Per i box dei messaggi usati nell'interfaccia
imbox {{Imbox}} Per i box dei messaggi usati nei file
tmbox {{Tmbox}} Per i box dei messaggi usati nelle discussioni
ombox {{Ombox}} Per i box dei messaggi usati negli altri namespace

Vedi la pagina di ogni template per i parametri disponibili.

Uso tramite #invoke[modifica]

Così come la funzione main, qesto modulo ha funzioni separate per ogni tipologia di box. Vi si accede usando il codice {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}}, ecc. Funzioneranno quando vengono richiamati da altri moduli, ma accedono al codice utilizzato per elaborare gli argomenti passati da #invoke, e quindi chiamarli sarà meno efficiente che chiamare main.

Dettagli tecnici[modifica]

Il modulo usa diversi Il modulo utilizza lo stesso codice di base per ciascuno dei modelli sopra elencati; le differenze tra ognuna di esse sono configurate utilizzando i dati in Module:Message box/configuration. Ecco le varie opzioni di configurazione e il loro significato:

  • types - una tabella contenente i dati utilizzati dal parametro type della finestra di messaggio. Le chiavi della tabella sono i valori che possono essere passati al parametro type e i valori della tabella sono tabelle che contengono la classe e l'immagine utilizzata da quel tipo.
  • default - il tipo di stile da utilizzare se non è viene passato alcun valore al parametro type o se è stato specificato un valore non valido.
  • showInvalidTypeError - per mostrare un errore se il valore passato al parametro type non è valido.
  • allowBlankParams - di solito i valori vuoti vengono rimossi dai parametri passati al modulo. Tuttavia, lo spazio bianco viene mantenuto per i parametri inclusi nella tabella allowBlankParams.
  • allowSmall - se è possibile visualizzare una versione ridotta della finestra di messaggio con "small=yes".
  • smallParam - un mome personalizzato per il parametro small. Per esempio, se viene impostato su "left" è possibile usare una vinestra piccola usando "small=left".
  • smallClass - la classe da utilizzare per il box del messaggio piccolo.
  • substCheck - whether to perform a subst check or not.
  • classes - un array delle classi da utilizzare con i box.
  • imageEmptyCell - se utilizzare un a cella <td>...</td> se non ci sono immagini impostate. Viene utilizzato per preservare la spaziatura delle finestre di messaggio con una larghezza inferiore al 100% dello schermo.
  • imageEmptyCellStyle - se deve essere applicato uno stile alle cella vuote delle immagini.
  • imageCheckBlank - se "immagine=blank" non visualizza alcuna immagine.
  • imageSmallSize - in genere, le immagini utilizzate nelle caselle di messaggio piccole sono impostate su 30x30 px. Questo imposta una dimensione personalizzata.
  • imageCellDiv - se racchiudere l'immagine in un div che applica la dimensione massima dell'immagine.
  • useCollapsibleTextFields - e utilizzare i campi di testo che possono essere compressi, ad esempio "problema", "fix", "discussione", ecc. Attualmente utilizzato solo in ambox.
  • imageRightNone - se immaginedestra=none non visualizza nessuna immagine sul lato destro della finestra del messaggio.
  • sectionDefault - il nome di default per il parametro "sect". Dipende da useCollapsibleTextFields.
  • allowMainspaceCategories - accettare la categorizzazione nel namespace principale.
  • templateCategory - il nome di una categoria da inserire nella pagina del template.
  • templateCategoryRequireName - se il parametro nome è necessario è necessario per visualizzare la categoria del template.
  • templateErrorCategory - il nome della categoria di errore da utilizzare nella pagina del template.
  • templateErrorParamsToCheck - una serie di nomi di parametri da controllare. Se sono assenti, templateErrorCategory </ code> viene applicato alla pagina del template.