OBS_AAAA - AlessiaValentiNAS/Linee-guida GitHub Wiki
Titolo h1 con il nome della parte senza underscore, senza prefisso Cod per i manoscritti, seguito, tra parentesi quadre, dal nome della parte nel menu a tendina
La x Part permette di...
Se necessario, usare l'elenco puntato.
Ogni frase costituisce un paragrafo a sé [per l'a capo va inserito: punto, due spazi, a capo, eventuale riga bianca]
La descrizione del modello è disponibile su Github.
Separare con la barra / tre asterischi la spiegazione su come aggiungere la parte e le eventuali sottoparti
Per aggiungere la x Part, selezionare x dal menu a tendina della scheda di riepilogo dell'item, quindi cliccare sul tasto add part.
Per aggiungere un xxxx, una volta creata la parte, cliccare su add x.
Per l'indicazione dei campi obbligatori per il salvataggio, scrivere sempre, sotto al campo obbligatorio: Campo obbligatorio. Questa informazione è la prima che si dà nei campi obbligatori, seguito da a capo più riga bianca (= punto, due spazi, a capo, riga bianca)
USO DEI TITOLI
Il titolo della parte, in quanto titolo generale e come già detto sopra, va in h1.
Di qui, a scalare secondo la gerarchia della parte. P. es., elementi/sezioni sono sempre h2; sottocapi/elementi di sezioni sono h3, e così via.
Ogni volta che un campo o una parte da compilare, sia essa obbligatoria o meno, va 'aggiunta' spuntando un flag o selezionando un 'add qualcosa', separare questa indicazione dal resto con la barra / tre asterischi. Usare queste formule:
- Se..., spuntare x. Per la compilazione vedi x.
- Per inserire una data/size, spuntare xxx. Per la compilazione vedi x.
- Per inserire una data/xxx, cliccare su add x. Per la compilazione vedi x.
Eventuali spiegazioni o precisazioni rispetto a come compilare (p. es più elementi data o tante ssertion quante sono le attribuzioni), vanno scritte a seguire.
Regole generali.
La prima volta che si cita una parte o un campo, il titolo della parte o del campo va in grassetto. Per il resto, per ora, in attesa di revisione cosmetica globale, usare il grassetto soltanto per segnalare le cose importanti.
Per i rimandi ad altri brick di linee guida, usare la forma: Per la compilazione vedi x.