English

La HelpPatch dimostra la funzionalità di un nodo. Idealmente, chi comincia con vvvv dovrebbe essere in grado di afferrare i concetti principali legati al nodo senza sforzo, ed un esperto ricavarne informazioni dettagliate.

Come impostare la Patch

• cominciare dalla template delle helppatch che può essere trovata in \modules\aTemplate () help.v4p
• salvare la template con un nome congruente al nodo cui si riferisce: MioNodo (Mia Categoria) help.v4p

• individuare lo scenario di utilizzo più semplice per il nodo - per una panoramica veloce per il principiante
• ora inserire una ulteriore spiegazione, di una situazione più complessa, ed inserirla proprio accanto a quella semplice
• se ci fossero altre situazioni degne di essere spiegate, inserire anche queste accanto alle altre

• generate IOBoxes per i pins di input che non vengono lasciati coi valori di default
• non etichettateli (come con il click del pulsante centrale del mouse, ad es.), piuttosto scrivete un commento accanto e spiegate il loro uso

• in ogni testo/commento per favore rimanete fedeli alle convenzioni sui nomi
• generate una sezione "also see", "vedi anche", in cui inserire i nodi correlati che l'utente dovrebbe esaminare
• aggiungete links ad informazioni online (wikipedia, ...) a proposito delle funzionalità del nodo

Contributi

Se si vuole che la propria helppatch sia inclusa nella prossima release, postarla in questo thread: missing-helppatches