Guidelines

Sei un professionista del mondo IT? Uno studente o un ricercatore nell'ambito delle discipline legate al mondo Java? Hai partecipato a qualche progetto che ritieni di interesse generale per i lettori di MokaByte?

Scrivi con noi! Proponi il tuo articolo alla redazione e lo valuteremo per l'eventuale pubblicazione. È un'ottima occasione per portare le tue esperienze all'attenzione della comunità italiana IT.

L'attività di articolista garantisce tra l'altro un ampliamento della propria visibilità nel panorama delle tecnologie IT in Italia.

Gli argomenti?

Se avete lavorato a un progetto particolare, se siete esperti di una specifica tecnologia, se la tesi di laurea potrebbe interessare qualcuno, se ritenete di aver individuato le tendenze e le novità del mondo tecnologico che ruota intorno a Java, allora fatevi avanti. La tipologia dei temi trattati sul nostro web magazine è varia, e sicuramente il vostro articolo potrebbe interessare una fetta dei nostri lettori.
Per esempio, “recensioni” di prodotti e soluzioni, resoconti su eventi significativi, analisi di tecnologie, corsi pratici su un nuovo tool, illustrazione di un progetto svolto e delle tecnologie adottate… tutti questi, e anche molti altri, sono argomenti che possono trovare una loro collocazione.

Ma come faccio?

Invia una e-mail a redazione@mokabyte.it dettagliando la tua esperienza e le idee che intendi proporre per l'articolo e vedremo come è possibile farle rientrare nella pianificazione dei numeri di MokaByte… valuteramo magari anche se al momento certi argomenti o il taglio proposto meritano un approfondimento o una diversa angolazione.

Le indicazioni tecniche

Allora? Hai deciso di proporre qualcosa?  Nell'articolo linkato qui sotto ci sono tante indicazioni tecniche e pratiche per preparare l'articolo (lunghezza, taglio, modelli e linee guida per il testo e le immagini). Di seguito sono riportate un po' di  informazioni e  approfondimenti di cui potresti aver bisogno.

Che impostazione deve avere un articolo?

Dipende molto dalla sua tipologia: possiamo distinguere, da una parte, "recensioni" di prodotti, resoconti e commenti su eventi o tecnologie e, dall’altra, analisi tecniche, corsi (magari in più parti), articoli pratici.
Nel primo caso va bene una impostazione descrittiva, generica, magari con riferimenti ad altre tecnologie. Non sono necessarie parti di codice o esempi allegati, mentre qualche figura è richiesta proprio per facilitare la lettura del brano (spesso risulta faticoso leggere solo testo). La lunghezza può variare da 5k a 10-12k battute ("battute = caratteri spazi inclusi).

Se invece si tratta di un articolo tecnico allora si deve cercare per prima cosa di focalizzare l’obiettivo che si vuole raggiungere. Fatto questo si pensi di suddividere l’articolo in tre/quattro grandi "sezioni".
Nella prima si fa una breve descrizione/introduzione, nella seconda si entra nel problema con l’analisi a 360 gradi del problema, nella terza si affronta il cuore del problema (sezione dove si raggiunge l’obiettivo di cui sopra), e infine si termina con le conclusioni e i commenti. Non si dimentichi di aggiungere i riferimenti più importanti a libri, riviste, siti, risorse online.
Si cerchi sempre di mantenere la massima comprensibilità, la semplicità. Se inoltre il taglio è meno teorico, ma più pratico, allora si mettano molti esempi funzionanti, cercando di limitare le spiegazioni teoriche, rimandandole alla parte bibliografica.
La lunghezza di questo tipo di articoli deve essere compresa fra le 12-15k e le 20k battute (ossia: caratteri spazi inclusi), ma queste dimensioni non sono tassative.
Chi non si sente di scrivere di più, non rinunci del tutto a scrivere: un buon articolo deve avere anche il dono della sintesi, per cui potrebbe essere anche più breve.

Come inviare un articolo?

Per confezionare l’articolo è bene attenersi al template per l'articolista scaricabile qui

L’articolo sarà composto da queste parti:

  • abstract (max 500 caratteri): sarà visibile sulla pagina della sezione in cui vengono presentati tutti gli articoli di un numero della rivista. È il breve riassunto dell’articolo, che lo presenta e ne descrive i contenuti.
  • introduzione (max 500 caratteri, ma meglio più breve): l’introduzione appare nella pagina stessa dell’articolo. Deve rappresentare una chiara e concisa illustrazione del senso dell’articolo
  • titolo dell’articolo
  • sottotiolo dell’articolo (se in più puntate, allora farlo precedere da "IV parte:", con il numero in cifre romane)
  • nome cognome autore
  • e-mail dell’autore

Una volta che il suo articolo è stato accettato, l’autore dovrebbe anche inviare una sua fotografia, in formato "base 100 pixel x altezza 150 pixel" e una sua breve biografia professionale, per la "scheda-autore". Tutto il materiale che compone un articolo deve essere inviato alla redazione in formato compresso ZIP. L’archivio ZIP deve contenere l’articolo in formato .rtf, .odt o anche .doc, tutte le immagini in formato .jpg o vettoriale raccolte in una sottodirectory apposita (denominata "immagini").

Le immagini

Le foto e le immagini devono essere separate dall’articolo e collocate dentro una cartella "immagini". I nomi delle immagini dovranno essere del tipo "nomearticolo_fig01.jpg". Nel punto dell’articolo in cui va inserita l’immagine, dovrà esserci un riferimento del tipo

<<nomearticolo_fig01.jpg>>
Figura 1 - Questa è la didascalia della figura 1

IMPORTANTE: non inglobare nessun oggetto direttamente nell’articolo.

Note tecniche sulle immagini

Schermate descrittive e fotografie andranno inviate in formato raster: allegare pertanto dei file JPG di qualità alta, a una risoluzione di 72 o 96 ppi. All’atto della codifica JPEG, non esagerare mai con la riduzione di qualità! Sono necessarie JPG di ottima qualità! Si richiede che la larghezza massima delle immagini non superi grosso modo i 700 pixel.

Per quanto riguarda schemi, diagrammi, immagini simboliche esplicative e così via, è possibile e raccomandato inviare le immagini in formato vettoriale. Nel caso di visual tool UML, ad esempio, si controlli se il programma può esportare in formati vettoriali quali, in ordine di preferenza, EPS, ODG, SVG, EMF o altri formati vettoriali standard.

Oltre ai software proprietari divenuti "industry standard", sono ormai disponibili alcuni programmi open source e cross platform per realizzare differenti tipologie di diagrammi e per il disegno vettoriale. Tra i software di disegno vettoriale, si ricorda Inkscape (http://www.inkscape.org/) da corredare con una adeguata libreria di clip-art (per esempio quella del progetto Open ClipArt,  http://www.openclipart.org/downloads/index.php). La suite OpenOffice.org (http://www.openoffice.org) comprende Draw, uno strumento di disegno vettoriale adatto per realizzare tale tipo di immagini.

Il codice

Il codice deve essere indentato secondo le ormai note Java Code Conventions definite da Sun; in particolare l’autore deve fare attenzione che la larghezza del codice non superi le 80 battute. Su un piano meramente redazionale, per i rientri (indent) è assai preferibile l’uso di tabulazioni invece che di spazi.

I commenti devono iniziare sempre a caporiga e precedere la riga di codice interessata.
Ad esempio

// ecco un commento molto lungo che inizia bene
// e finisce alla riga sottostante
MyClass.runMethod();

MyClass.runMethod();// ecco un commento non corretto

Quali scadenze?

Una volta che l’articolo sia stato accettato dalla redazione, esso deve essere consegnato in forma definitiva al massimo entro il 20 del mese precedente quello di uscita della rivista. Ad esempio, per il numero di giugno, è bene che il materiale arrivi entro il 20 maggio.
Una volta consegnato, se non ci sono particolari controindicazioni, l’articolo verrà impaginato e messo online con il nuovo numero. Variazioni potranno essere decise all’ultimo momento per esigenze editoriali.

In nessun caso un articolo approvato verrà poi cestinato, ma sarà solo eventualmente rimandato.