Modulo:Avanzamento/man
Questa è la pagina di documentazione per Modulo:Avanzamento
Questo modulo serve per inserire lo stato di avanzamento di un libro o un modulo. Grazie al modulo ArrotondoPercentuale, con cui questo è integrato, le percentuali delle fasi di sviluppo vengono arrotondate, ed è inoltre possibile aggiungere messaggi personalizzati e categorizzazione.
Sintassi
[modifica sorgente]Essendo questo modulo un potenziamento, usando Lua, del codice del vecchio template "Avanzamento", il suo uso è strettamente connesso alle esigenze di quel template, quindi il modo principale di usarlo è proprio tramite {{Avanzamento}}
Uso diretto
[modifica sorgente]Nonostante questo, in futuro potrebbe essere necessario usarlo direttamente integrandolo in un template.
{{#Invoke:Avanzamento|main|{{{1}}}}}
Per un approfondimento sui valori arrotondati, è possibile fare riferimento al manuale del modulo "ArrotondoPercentuale"
Variabili
[modifica sorgente]Alcune variabili di questo modulo possono essere modificate agevolmente per aggiornare i messaggi e le categorie. I testi degli avvisi e le categorie da aggiungere sono inseriti all'interno del Modulo:Avanzamento/configurazione.
Nomi delle categorie
[modifica sorgente]Descrizione | Variabile | Valore di default |
---|---|---|
Nome della categoria in cui categorizzare le pagine con le percentuali compilate in maniera errata | CatError
|
Avanzamento con errori di compilazione |
Nome della categoria in cui ctegorizzare le pagine con le percentuali arrotondate | CatArrotondo |
Testo degli avvisi
[modifica sorgente]Descrizione | Variabile | Valore di default |
---|---|---|
Avviso da far apparire quando viene inserita una percentuale composta soltanto da valori numerici, omettendo il segno "%" | AvvisoError
|
Percentuale inserita in maniera errata, è necessario aggiungere il segno di percentuale ("%"). |
Testo di aiuto che appare quando viene inserita una percentale errata. La pagina verrà comunque categorizzata arrotondando.
|
AvvisoArrotondo |
La percentuale inserita ('..Digit..'%) non è stata riconosciuta, è stata quindi arrotondata a '..arrotondo..'. |
Testo da visualizzare dopo gli avvisi precedenti | LinkAiuto |
Per un approfondimento vedi "[[Aiuto:Fasi di sviluppo]]" |
Testo visualizzato come testo del link di modifica della pagina. È la variabile $2 del messaggio standard AvvisoStub | TestoLinkModifica |
Contribuisci |
Testo da visualizzare negli stub, quando la percentuale è uguale a "00%". La variabile $1 cambierà a seconda se si tratta di un modulo o di un libro. | AvvisoStub |
[[File:Wiki letter w.svg|25px|Questa pagina è uno stub]]'.. '\'\'Questo [[Aiuto:$1|$1]] è solo un [[Aiuto:Stub|abbozzo]]. '.. '$2 a migliorarlo secondo le [[Aiuto:Manuale di stile|convenzioni di Wikibooks]]\'\' |
Testo da visualizzare prima dell'AvvisoStub quando questo è frutto di un arrotondamento. Se il messaggio è lasciato vuoto, verrà automaticamente preso il valore di AvvisoArrotondo.
|
AvvisoArrotondo0 |
AvvisoError
, AvvisoArrotondo
e AvvisoArrotondo0
sono racchiusi nel tag <strong class="error">, facendo visualizzare il messaggio di colore rosso, e il font leggermente più grande e spesso
Altre variabili
[modifica sorgente]Queste variabili invece sono indipendenti dal modulo, ma sono date dal Modulo:ArrotondoPercentuale.
Descrizione | Variabile | Note |
---|---|---|
Valore numerico inserito. Questo valore è interno al ArrotondoPercentuale che si occupa anche di processarlo. | Digit
|
Anche se inserito con il segno di percentuale, questo valore sarà sempre e soltanto numerico. |
Valore numerico percentuale a cui è stato arrotondato il valore inserito Digit | arrotondo |
Questa variabile, anche se interna è dipendente dal ArrotondoPercentuale, è infatti questo modulo che, arrotondando il valore dato, restituisce questo valore. |