Le macro

Le macro consentono di inserire nuove funzionalità nelle normali pagine wiki; l'unica cosa che le rende speciali è che contengono delle macro. Se si modificano pagine tipo ModificheRecenti o InformazioniSulSistema, è possibile vedere cosa si intende.

Per ulteriori informazioni sulle possibili formattazioni, consultare AiutoSuModificaPagina.

Macro di ricerca

MoinMoin utilizza un nuovo motore di ricerca, che consente di svolgere ricerche sofisticate utilizzando sia il riquadro di ricerca interattiva sia una qualsiasi delle macro di ricerca. Per un ulteriore aiuto, consultare AiutoSuRicerche.

Macro


Descrizione

Esempio

<<AdvancedSearch>>


Crea un dialogo di ricerca avanzata nella pagina

Consultare CercaPagina

<<TitleSearch>>


Crea un riquadro di ricerca nella pagina che cerca tra i titoli delle pagine

Consultare CercaPagina

<<FullSearch>>


Crea un riquadro di ricerca nella pagina che cerca nel contenuto delle pagine

Consultare CercaPagina

<<FullSearch()>>


Elenca le pagine che contengono il titolo della pagina (come facendo clic sul titolo della pagina)

Consultare la pagina CategoriaCategoria

<<FullSearch(text)>>


Elenca le pagine che contengono il termine ricercato

<<FullSearchCached(text)>>


Lavora come la macro FullSearch ma crea una cache statica dei risultati. Utilizzarla se si preferisce cercare velocemente su un risultato aggiornato

<<GoTo>>


Vai direttamente alla pagina indicata

Consultare CercaPagina

<<PageList(Help)>>


Elenca le pagine il cui titolo corrisponde al termine ricercato

Consultare AiutoIndice

Macro


Descrizione

Esempio

<<RecentChanges>>


Elenco di pagine modificate di recente

Consultare ModificheRecenti

<<TitleIndex>>


Indice di tutti i titoli delle pagine

Consultare IndiceDeiTitoli

<<WordIndex>>


Indice di tutte le parole nei titoli delle pagine

Consultare IndicePerParola

<<WantedPages>>


Elenco di pagine che non esistono

Consultare PagineAssenti

<<OrphanedPages>>


Elenco di pagine non referenziate da altre pagine

Consultare PagineOrfane

<<AbandonedPages>>


Elenca le pagine non modificate da più tempo

Consultare PagineAbbandonate

<<RandomPage>>


Collegamento a una pagina a caso

<<RandomPage>>

<<RandomPage(#)>>


Collegamenti a un dato numero di pagine a caso

Due pagine a caso:<<RandomPage(2)>>

<<TableOfContents([maxdepth])>>


Visualizza un indice locale, limitato a una profondità massima (maxdept)

Consultare inizio pagina

<<Anchor(anchorname)>>


Macro per inserire "ancore" in una pagina

#qui

<<Navigation(children[,maxdepth])>>


Macro che elenca tutte le pagine che discendono da una pagina

Consultare inizio pagina

<<Navigation(siblings[,maxdepth])>>


Navigazione rapida tra pagine sullo stesso livello

Consultare /MailTo

<<Navigation(slideshow)>>


Crea un collegamento per passare da modalità presentazione a quella wiki e uno per far partire la presentazione

Consultare AiutoSuPresentazione

<<Navigation(slides)>>


Mostra i collegamenti a prima/precedente/prossima/ultima slide

Consultare AiutoSuPresentazione

<<AttachInfo>>


Mostra il numero di file allegati alla pagina attuale

Consultare AiutoSuAzioni/AllegaFile

<<AttachInfo(page)>>


Mostra il numero di file allegati alla pagina indicata

Consultare AiutoSuAzioni/AllegaFile

<<AttachList(pagename,mimetype)>>


Mostra l'elenco dei file allegati

Consultare AiutoSuAzioni/AllegaFile

Informazioni di sistema

Macro


Descrizione

Esempio

<<Hits>>


a counter for page hits <<Hits([all=(False,True)][,event_type=(VIEWPAGE,SAVEPAGE)]>>

315

<<InterWiki>>


Elenco di tutti i nomi InterWiki conosciuti

InterWiki

<<SystemInfo>>


Informazioni sul wiki, sull'interprete Python e sul sistema ospite

InformazioniSulSistema

<<PageCount(exists)>>


Calcolo del numero di pagine attuali. Se viene utilizzato come argomento exists, verranno mostrate solo le pagine esistenti.

20787 pagine

<<PageSize>>


Elenca le dimensioni di tutte le pagine

Consultare PaginePerDimensione

<<StatsChart(type)>>


Mostra grafici statistici (attualmente sono definiti questi tipi: hitcounts, pagesize, useragents)

Consultare StatisticheEventi e sottopagine

<<SystemAdmin>>


Informazioni per gli amministratori del sistema

Bisogna essere superuser per utilizzare questa macro

<<EditedSystemPages>>


Elenco di tutte le pagine di sistema modificate

  1. BadContent
  2. LocalSpellingWords
  3. PáginaDeTestesWiki
  4. WikiSandBox

<<WikiConfig>>


Mostra al super-utente le impostazioni della configurazione del wiki diverse dalle quelle predefinite

È necessario essere super-utente per utilizzare questa macro
<<WikiConfig>>

<<WikiConfigHelp>>


Mostra la descrizione di tutti i parametri di configurazione

<<WikiConfigHelp>>

Altre

Macro


Descrizione

Esempio

<<Action(action [,text])>>


Collega una pagina con un'azione valida, il testo opzionale può essere utilizzato come alias (i nomi delle azioni fanno distinzione tra maiuscole e minuscole)

<<Action(print, Stampa questa pagina)>>, Stampa questa pagina

<<Icon(image)>>


Mostra icone di sistema

Consultare AiutoSuNavigazione

<<BR>>


Forza un a capo

Prima riga
seconda riga

<<RandomQuote(pagename)>>


Seleziona una parte di testo a caso della pagina indicata o da BiscottiDellaFortuna se questa viene omessa

Suggerimento: visualizza la cronologia delle modifiche nella pagina ModificheRecenti facendo clic sulla colonna i (per informazioni).

<<Include(HelloWorld[,"heading"[,level]])>>


Include i conenuti di un'altra pagina

Per dettagli consultare /Includi

<<FootNote(text)>>


Aggiunge una nota a fondo pagina1 oppure mostra tutte le note a piè di pagina se non viene fornito un argomento

Consultare l'esempio a fine pagina

<<Date(timestamp)>>


Mostra la data come da impostazioni di sistema

2015-08-31

<<DateTime(timestamp)>>


Mostra data e ora2 come da impostazioni utente

2015-08-31 18:16:12

<<GetText(text)>>


Carica le traduzioni I18N (per utilizzi su pagine di Aiuto)

"EditText" viene tradotto in "EditText"

<<GetText2(,message,argument1,argument2,...)>>


Carica le traduzioni I18N (per utilizzi su pagine di aiuto o su pagine wiki con output generato) e sostituisce %s nel messaggio a seconda degli argomenti. Il primo carattere dell'argomento è utilizzato come separatore (in questo esempio: una virgola). Si può evitare il separatore utilizzando una barra rovescia.

"<<GetText2(,[You may not read %s],FooBar)>>" diventa "[You may not read FooBar]"

<<TeudView>>


Utile per wiki di sviluppo su intranet, per visualizzare documentazione pydoc formattata con un foglio di stile XSLT

Vedi http://twistedmatrix.com/wiki/python/TeudProject

<<MailTo(email)>>


Protegge il tuo indirizzo email dagli spam bot

Per dettagli vedi /MailTo

<<NewPage(PageTemplate,ButtonLabel,[ParentPage,@ME,@SELF] [,NameTemplate])>>


Permette agli utenti di creare con facilità (sotto-) pagine, usando la pagina PageTemplate come modello per una nuova pagina e la stringa NameTemplate come maschera per il nome.3 @ME viene utilizzato se si vuole creare la pagina come sotto pagina della pagina personale. @SELF viene utilizzato per creare una sotto pagina sotto la pagina dalla quale viene invocata la macro.

<<GetVal(NeatSnippets,regards)>>


Restituisce il corrispondente trovato nelle pagine dizionario.

Nel caso esistesse una pagina GermanDict contenente la voce Test, dovresti vederne la traduzione qui:

 <<MonthCalendar(,,12)>>


Mostra un calendario e crea i collegamenti per ogni giorno in sottopagine

Vedi /CalendarioMensile

  1. Il testo non può contenere alcuna formattazione wiki (1)

  2. "timestamp" può essere vuoto (ora attuale), un numero di secondi dal 1970 (unix timestamp) o una specifica temporale W3C ("2002-01-23T12:34:56"). Vedi RFC822, sez. 5. (2)

  3. NameTemplate viene formattato come time.strftime(), con l'eccezzione che %s viene sostituito da quanto inserito nel riquadro di modifica (che viene mostrato solo se richiesto). Se NameTemplate non viene specificato o è vuoto, viene sostituito in modo predefinito con %s. (3)

Scrivere una macro

Creare un file python di nome NomeMacro.py nella directory data/plugin/macro. Assicurarsi che abbia una sola funzione chiamata macro_NomeMacro(macro, arg1, arg2, ...) che ne costituisce il punto iniziale.

È possibile accedere all'oggetto request usando macro.request, per esempio per accedere ai parametri di un modulo e ad altre informazioni dell'utente.

La funzione dovrebbe usare il formattatore per costruire un markup valido per il tipo di pagina. Nella maggior parte dei casi è HTML, quindi creare una macro che ritorna HTML funzionerà quasi sempre a parte quando sono richiesti formati come XML o plain/text (è possibile usare macro.formatter per accedere al formattatore corrente).

Per esempio, la propria pagina wiki contiene le seguenti righe:

<<NomeMacro(True, 1.7772, 17)>>

È possibile creare un file NomeMacro.py in questo modo:

   1 from wikiutil import get_unicode, get_bool, get_int, get_float
   2 
   3 Dependencies = []
   4 generates_headings = False
   5 
   6 def macro_NomeMacro(macro, arg1, arg2, arg3=7):
   7     # gli argomenti possono essere None o un oggetto unicode
   8 
   9     arg1 = get_bool(macro.request, arg1)
  10     arg2 = get_float(macro.request, arg2)
  11     # dato che arg3 ha un valore predefinito di 7, è sempre un int long
  12 
  13     return macro.formatter.text("gli argomenti sono: %s %2.3f %d" % (arg1, arg2, arg3))

Se la macro è in grado di generare titoli (chiamando macro.formatter.heading()), impostare generates_headings a True per consentire alla macro TableOfContents di analizzare la propria macro alla ricerca dei titoli da usare.

Argomenti della macro

Gli argomenti passati alla macro sono normalmente istanze unicode di None se l'utente non ha fornito alcun valore.

Considerare questo esempio:

   1 def macro_Example(macro, arg1, arg2):
   2   ...

e il codice wiki (coi risultati)

 1. <<Example()>>            - passa None, None
 2. <<Example(a,b)>>         - passa u'a', u'b'
 3. <<Example(,)>>           - passa None, None
 4. <<Example("",)>>         - passa u'', None

Valori predefiniti

Se la macro dichiara dei valori predefiniti come in questo esempio:

   1 def macro_Example(macro, arg1=7, arg2=2.1):
   2   ...

Gli argomenti possono quindi essere saltati e vengono convertiti automaticamente al valore predefinito:

 1. <<Example()>>            - passa 7, 2.1
 2. <<Example(,3)>>          - passa 7, 3.0
 3. <<Example(2)>>           - passa 2, 2.1
 4. <<Example(a,7.54)>>      - errore, "a" non è un intero

Inoltre, è possibile dichiarare il tipo che si vuole ottenere:

def macro_Example(macro, arg1=int, arg2=float):
  ...

In questo modo l'utente è obbligato a inserire il parametro corretto, ma è possibile evitare questo passando un argomento vuoto nel cui caso la macro riceverà il valore None:

 1. <<Example()>>            - passa None, None
 2. <<Example(a, 2.2)>>      - errore, "a" non è un intero
 3. <<Example(7, 2.2)>>      - passa 7, 2.2
 4. <<Example(, 3.14)>>      - passa None, 3.14

Argomenti unità

Se la propria macro dichiara degli argomenti con unità, le stesse sono richieste:

   1 from MoinMoin import wikiutil
   2 def macro_Example(macro, arg1=wikiutil.UnitArgument(None, float, ['px', '%'], defaultunit='px')):
   3     if arg1:
   4         if arg1[1] == 'px':
   5             arg1 = '%dpx' % int(arg1[0])
   6         else:
   7             arg1 = '%g%s' % arg1
   8     return macro.formatter.text("argument is: %s" % (arg1))

Il valore di defaultunit, px, è utilizzato se l'utente non ne inserisce uno e deve inserire le unità valide come "px" o "%".

 1. <<Example()>>             - argomento è: None
 2. <<Example(100)>>          - argomento è: 100px
 3. <<Example(100mm)>>        - <<Example: Invalid unit in value 100mm (allowed units: px, %)>>
 4. <<Example(100px)>>        - argomento è: 100px

Scelte

Se la propria macro può accettare diverse scelte, è possibile dichiararlo come segue:

   1 def macro_Example(macro, fruit=(u'apple', u'orange')):
   2   ...

Questo richiede che l'utente inserisca una qualsiasi delle scelte fornite e utilizza la prima nel caso non ne sia fornita alcuna:

 1. <<Example(apple)>>       - passa u'apple'
 2. <<Example(OrAnGe)>>      - errore, indica all'utente quali scelte sono valide
 3. <<Example()>>            - passa u'apple'

Argomenti richiesti

Se devono essere richiesti degli argomenti, è possibile indicarlo usando la classe required_arg istanziata ottenendo il tipo dell'argomento:

from MoinMoin.wikiutil import required_arg

def macro_Example(macro, arg1=required_arg(int)):
  ...

Questo richiede che l'utente inserisca l'argomento:

 1. <<Example()>>            - errore, argomento "arg1" richiesto
 2. <<Example(4.3)>>         - errore, "4.3" non è un intero
 3. <<Example(5)>>           - passa 5

Argomenti chiave

Se la propria macro deve accettare degli argomenti arbitrati sotto forma di chiavi da passare a qualcos'altro, deve dichiarare un parametro _kwargs con valore predefinito un dizionario vuoto:

   1 def macro_Example(macro, _kwargs={}):
   2   ...

Questo fa in modo che l'utente posso passare qualsiasi valore, anche stringhe unicode arbitrarie:

 1. <<Example(äöü=7)>>       - passa il dizionario {u'äöü': u'7'}
 2. <<Example(=7)>>          - passa il dizionario {u'': u'7'}
 3. <<Example(a=1,"d e"=3)>> - passa il dizionario {u'a': u'1', u'd e': u'3'}
 4. <<Example(a)>>           - errore, troppi argomenti non-chiave

Argomenti di coda

Gli argomenti di coda consento alla propria macro di accettare un qualsiasi numero di argomenti posizionale o consentono di gestire la sintassi di macro come:

[[Macro(1, 2, 3, name=value, name2=value2, someflag, anotherflag)]].

Per poter gestire tutto questo, dichiarare un parametro _trailing_args con un elenco vuoto come valore predefinito:

   1 def macro_Example(macro, i1, i2, i3, name, name2, _trailing_args=[]):
   2   ...

Inoltre, quando l'utente fornisce troppi argomenti, questi sono inseriti in _trailing_args:

 1. <<Example(1, 2, 3, name=test, name2=test2, flag1)>>   - valido, passa u'flag1' in _trailing_args
 2. <<Example(1, 2, 3, test, test2, flag1)>>              - idem

È possibile usare questa caratteristica assieme al parametro _kwargs.