mozilla
Risultati di ricerca

    The MDN editing interface

    L'editor WYSIWYG (what-you-see-is-what-you-get) offerto da MDC rende semplice contribuire con nuovi contenuti per il Centro di Documentazione MDN. Questo articolo fornisce alcune informazioni sull'uso dell'editor, nonchè qualche informazione su utili caratteristiche che potrebbero migliorare la propria produttività.

    La Guida allo sitle di MDC fornisce informazioni su come formattare e applicare lo stile al contenuto.

    Scorciatoie da tastiera

    Ci sono numerose scorciatoie da tastiera disponibili per evitare di togliere le mani dalla tastiera mentre si lavora. Le scorciatoie sono elencate per Windows e Linux; su Mac, invece di utilizzare il tasto Control, utilizzare il tasto Command.

    Shortcut Description
    Ctrl-A Seleziona tutto
    Ctrl-C Copia negli appunti
    Ctrl-V Incolla dagli appunti
    Ctrl-X Taglia
    Ctrl-Z Annulla
    Ctrl-Y Ripristina
    Ctrl-K Apri l'editor dei link
    Ctrl-B Grassetto
    Ctrl-I Corsivo
    Ctrl-O Alterna con lo stile <code>.
    Ctrl-Shift-O Alterna con la modalità vista sorgentesource view mode.
    Ctrl-P Alterna con lo stile <pre> sul blocco corrente.
    Ctrl-U Sottolineato
    Ctrl-S Salva ia cambiamenti ed esci dall'editor
    Ctrl-Shift-S Salva i cambiamenti senza uscire dall'editor
    Ctrl-2
    fino a Ctrl-6
    Seleziona il livello d'instestazione da 2 a 6
    Ctrl-Shift-L Alterna tra elenco a pallini, numerato e il formato paragrafo
    Tab Incrementa il livello di rientro se in modalità rientro, altrimenti inserisce due spazio come tabulazione. All'interno di tabelle, provoca il salto alla cella successiva, o inserisce una nuova riga se non ci sono ulteriori celle. Se il cursore è nel titolo della pagina o in una intestazione, il cursore salta al paragrafo successivo.
    Shift-Tab Decrementa il livello di rientro se in modalità rientro. All'interno delle tabelle, provoca il salto alla cella precedente, o inserisce una nuova riga se non ci sono ulteriori celle precedenti. Se il cursore è nel titolo della pagina o in una intestazione, il cursore salta la paragrafo successivo.
    Shift-Space Inserisce uno spazio senza interruzione (&nbsp;)
    Shift-Enter

    Esce dal blocco corretne. Per esempio, se si sta modificando un blocco <pre>, esce dal blocco, tornando al corpo dell'articolo.

    Nota: Attualmente non implementato; vedere bug 780055.

    Includere una nota di revisione

    Quando si salvano i cambiamenti, è utile includere una nota che spieghi perchè sono stati fatti. Inserire del testo nel box "Edit summary" sotto l'editor prima di salvare i cambiamenti.

    C'è qualche ragione che lo rende utile:

    • Se la ragione dei cambiamenti non è ovvia, la nota può spiegare le ragioni agli altri
    • Se il cambiamento è tecnicamente complesso, può spiegare agli editor la logica che vi sottende; incluso un nuero di bug, per esempio, cui gli editor possono riferirsi per maggiori informazioni.
    • Se la modifica coinvolge la cancellazione di una grande quantità di contenuto, può essere giustificata tale cancellazione (per esempio, "Contenuto spostato all'articolo X").

    Collegamento

    Ci sono alcuni modelli che rendono semplice la creazione di collegamenti nella pagina. Per esempio si può collegare una sezione con un dato nome utilizzando il modello anch, come segue:

    {{ anch("Includere una nota di revisione") }}

    Ciò inserisce un'ancora come questa: Includere una nota di revisione.

    Nello scrivere la documentazione dell'interfaccia, e si ha bisogno di collegare un metodo nell'articolo corrente, è possibile utilizzare il modello manch, come segue:

    {{ manch("methodName") }}

    Questo appare come: methodName().

    Utilizzare codice d'esempio vivo

    Nota: Il sistema per esempi vivi è ancora sotto pesante sviluppo, e potrebbe o meno lavorare correttamente in un dato momento. E' possibile che siano applicati cambiamenti, per renderlo più semplice, che rendono questa documentazione obsoleta prima che possa essere aggiornata. Tuttavia si cercherà di tenere aggiornate queste informazioni!

    Il wiki MDN supporta esempi di codice vivo. Questi esempi utilizzano HTML, e possono anche far uso di CSS e JavaScript. Per utilizzare il sistema di esempi vivi, clicca il pulsante "Insert Code Sample Template", posizionato nella seconda riga della barra degli strumenti. La sua icona è la seguente: What the live sample button in the toolbar looks like

    Cliccando il pulsante è richiesto l'inserimento di un titolo per l'esempio, poi sono aggiunte parecchie cose all'articolo: un'intestazione e un elenco di blocchi <pre>. Uno è per il codice HTML d'esempio, uno per il CSS, e uno per Javascript. Ciascuno ha la propria sottointestazione, per chiarire ulteriormente chi è chi. E' possibile rimuovere i blocchi CSS o JavaScript, o le instestazioni se non se ne ha bisogno.

    Nota: In realtà, l'esempio non ha bisogno di avere anche un'intestazione. Se si trova in un <div> o in altro blocco, puoi anche utilizzare l'ID di quel blocco.

    Si completi ogni blocco di codice come richiesto, rimuovendo qualunque esempio non necessario. Si possono anche aggiungere pià blocchi di codice; il sistema di esempio automaticamente concatena tutti i frammenti di codice HTML, CSS e JavaScript e li utilizza tutti insieme. In tal modo è possibile descrivere come come lavora l'esempio un pezzo alla volta, e questi continuerà a funzionare!

    C'è anche un <iframe> che visualizza l'esempio. E' possibile modificare le sue proprietà per personalizzare la dimensione ed altre caratteristiche, se lo si desidera. C'è anche il modello EmbedLiveSample, se lo si desidera utilizzare:

    {{EmbedLiveSample("section_id")}}

    E' importante notare che la "section_id" non è necessariamente la stessa dell'intestazione del codice d'esempio. Per esempio, caratteri non ASCII sono codificati e tutti gli spazi sostituiti con sottolineature. In più se il nome dell'intestazione non è unico nel tuo articolo, l'ID è modificato per essere unico. Quidni sebbene si cerchi di inserire nomi di sezione con sottolineature in sostituzione degli spazi, potrebbe essere necessario salvare il proprio articolo in modo che siano generati gli ID dal server, quidni modificarlo per aggiornare gli ID nella chiamate del modello. E' possibile determinare a qual'è l'ID guardando la parte seguente il carattere "#" nella tavola dei contenuti della pagina.

    E' anche possibile, opzionalmente, fornire parametri di ampiezza e altezza per EmbedLiveSample, che permettono di specificare la dimensione di <iframe>:

    {{EmbedLiveSample("section_id", 600, 100)}}

    In tal modo si crea un <iframe> di 600 pixel si ampiezza e 100 di altezza. Devono essere specificate entrambe; se se ne include solo una, è utilizzata la dimensione didefault del frame.

    Nota: E' anche utile notare che in molti casi, si dovrebbe essere capaci di aggiungere la chiamata al modello EmbedLiveSample per articoli esistenti con frammenti di codice e renderli funzionanati senza significativi (se ce ne sono) lavori extra. Purchè l'esempio sia in una delle sue sezioni, o possa essere facilmente messo in una, basta aggiungere il template ed è pronto.

    Cancellare una pagina

    Se si arriva ad una pagina che deve essere cancellata per un qualunque motivo, aggiungere semplicemente il tag "junk" ad essa. Un amministratore MDC rimuoverà la pagina subito dopo.

    Quali sono delle buone ragioni per marcare una pagina per la cancellazione?

    • La pagina è stata creata accidentalmente e non ha contenuto.
    • Il contenuto della pagina è stato fuso con un altro articolo.
    • La pagina è spam.
    • I contenuti della pagina sono così tristemente obsoleti da essere pericolosi.

    Utili comandi KumaScript

    Qualche volta, è utile trarre vantaggio da speciali comandi KumaScript per migliorare l'aspetto dei contenuti.

    Assicurare che i collegamenti sompleti siano visualizzati

    Per impostazione predefinita, il wiki MindTouch tronca gli URL lunghi quando li visualizza nel corpo degli articoli. Ciò non è quello che di norma vogliamo. Se si verifica tale circostanza, è possibile utilizzare il comando web.link per incorporare lURL completo, come segue:

    Troncato: http://www.bitstampede.com/2009/06/0...atures-on-mdc/

    In linea: http://www.bitstampede.com/2009/06/04/more-new-features-on-mdc/

    Ciò è fatto utilizzando il testo

    {{web.link("http://www.bitstampede.com/2009/06/04/more-new-features-on-mdc/")}}.

    Utilizzare l'evidenziazione della sintassi

    MDC supporta l'evidenziazione della sintassi per i codice d'esempio. Per utilizzarla, il primo passo è d'inserire il codice d'esempio nel documento

    void main(int argc, char **argv) {

    printf("Hello world\n");

    }

    Il secondo passo è di selezionare il testo e cliccare sull'incona "PRE" nella barra degli strumenti.

    void main(int argc, char **argv) {
      printf("Hello world\n");
    }
    

    Il terzo passo è di utilizzare il menu a discesa vicino all'icona "PRE" per selezionare il linguaggio corrispondente alla evidenziazione della sintassi che si desidera applicare. In questo caso si utilizzerà l'evidenziazione della sintassi C++.

    void main(int argc, char **argv) {
      printf("Hello world\n");
    }
    
    Nota: L'editor non visualizza l'evidenziazione della sintassi. E' necessario salvare l'articolo e guardarlo per vedere la sintassi evidenziata.

    Accedere al menu contestuale standard del tuo browser

    Per impostazione predefinita, l'editor utilizza il proprio menu contestuale quando si fa clic con il tasto destro sull'editor. Per accedere al menu contestuale di default del browser (al fine di acceder all'elenco delle correzioni suggerite dal controllo ortografico di FireFox), premere il tasto Control (tasto Command su Mac OS X) mentre si fa clic.

    La barra degli strumenti

    Alcune caratteristiche chiave della barra degli strumenti dell'editor sono trattate qui. Per maggiori informazioni, potresti voler controllare sulla Guida dell'utente di CKeditor; E' questo l'editor utilizzato da MDC.

    Il contenuto sottostante tutti gli articoli è HTML; può essere visualizzato in qualunque momento e modificato cliccando sul pulsante "Codcie Sorgente" nella barra degli strumenti.

    Il menu a discesa stile, posizionato nella riga bassa della barra degli strumenti, elenca un certo numero di stili comunemente utilizzti e che possono essere applicati al testo:
    • "Code (inline)" è utilizzato per brevi frammenti di codice, nomi di funzioni, classi, interfacce e così via.
    • "Plaintext (nowiki)" permette di contrassegnare una regione di contenuto, indicando che dovrebbe non essere elaborata dal wiki. Per esempio, ciò preveiene che URL nel mezzo del codice d'esempio siano trafromati in collegamenti cliccabili.
    • "Note" è utilizzato per paragrafi che includono informazioni inportanti da dover essere specificatamente estratte dal corpo dell'articolo. Un paragrafo di nota dovrebbe iniziare con "Nota:" in grassetto.
    • "Warning" è utilizzato per messaggi critici; tipicamente questi dovrebbero iniziare con "Avvertimento:" in grassetto.
    • "Callout box" è lo stile utilizzato per riquqdri di richiamo; è utilizzato in unione a modelli quali Template:gecko_callout_heading.
    • "Two columns" e "Three columns" dovrebbero essere autoesplicativi.

    Ridirezioni

    Se si ha bisogno di ridirigere una pagina verso un'altra, è possibile utilizzare il comando REDIRECT. Per far ciò, rendere l'intero contenuto dell'articolo come segue:

    REDIRECT <a class="redirect" href="%(location)s">%(title)s</a>

    Una volta fatto, qualunque visita alla pagina è automaticamente ridiretta alla location specificata.

    Se si ha successivamente bisogno di visualizzare una pagina che realizza un redirect, aggiungere semplicemente "?redirect=no" all'URL. Ciò evita il redirect di modo che la pagina possa essere visualizzata e modificata.

    Vedere anche

    Etichette del documento e nomi di chi ha collaborato alla sua stesura

    Contributors to this page: Grino
    Ultima modifica di: Grino,