Modulo:Esclusioni FileExport/man

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

Questa è la pagina di documentazione per Modulo:Esclusioni FileExport

Questo modulo viene utilizzato per categorizzare un file in base alla propria estensione. È possibile scegliere se farlo categorizzare in caso l'estensione scelta combaci con quella del file, oppure no.

Parametri da modulo[modifica]

Questo modulo permette di poter scegliere i parametri da testare e il nome delle categorie che verranno utilizzate in uno o nell'altro caso.

  • CategoriaEsclusioneDefault: è il nome predefinito della categoria che il modulo utilizzerà se l'estensione del file combacia con quella scelta tramite la variabile extControl.  Attualmente la categoria predefinita è "File esclusi dall'esportazione"
  • CategoriaInclusioneDefault è il nome predefinito della categoria che il modulo utilizzerà se l'estensione scelta non combacia con quella del file. Attualmente è stata lasciata vuota.
  • extControl: L'entensione da ricercare specificata tramite "estensione" (vd. sotto), se non specificato diversamente verrà usata "pdf"


Parametri personabilizzabili[modifica]

Per semplificare l'uso del modulo, e renderlo più versatile, è possibile specificare dei parametri per "sovrascrivere" quelli di default:

  • estensione: sovrascrive la variabile extControl
  • CategoriaEsclusione: il nome del parametro che è possibile usare per scegliere la categoria in cui verrà categorizzato il file se le due estensioni combaciano. Se non specificato il modulo utilizzerà il valore di CategoriaEsclusioneDefault
  • CategoriaInclusione: il nome del parametro che è possibile usare per scegliere la categoria in cui verrà categorizzato il file se le due estensioni non combaciano. Se non specificato il modulo utilizzerà il valore di CategoriaInclusioneDefault.

funzione isExportable[modifica]

Questa funzione sfrutta soltanto il parametro estensione per confrontare le due estensioni. Il suo unico scopo è quello di essere utilizzata in un template con un if, infatti resituisce solo "yes" se le due estensioni combaciano, o "no" se non combaciano. Anche in questo caso il parametro "estensione", se non diversamente specificato assumerà "pdf" come valore.