Repository 32bit  Forum
Repository 64bit  Wiki

Slacky.eu:Come scrivere un articolo (old version)

Da Slacky.eu.

Indice

Stesura di un articolo

All'inizio di un articolo è buona norma inserire la categoria in cui verrà poi visualizzato ([[Category:Nomecategoria]])

Un articolo deve avere un impaginazione divisa in = capitoli = e se serve in == sotto capitoli == ( per l'implemetazione del codice guardate il primo link). In generale quindi la struttura è questa:

Introduzione

In cui viene spiegato cosa spiega l'how-to

Componenti necessari

In cui si elenca cio di cui si ha bisogno per portare a termine l'how-to

Conoscenze

Se sono necessarie conoscenze avanzate per farlo (il più delle volte non è necessario)

L'how-to vero e proprio diviso in capitoli

Raccomando l'uso per le zone di codice dei tab <pre></pre> o di mettere il testo con uno spazio iniziale in modo che il testo risulti:

$ cat /proc/partitions/

E' inoltre sconsigliato l'uso dei </br>. Per andare a capo con il paragrafo dare volte [INVIO]

Conclusione

Conclusioni e commenti.

Autore:
per farla potete usare il tag ~~~~

Appunti sulla scrittura di how-to su configurazioni di Portatili o Computer

Per rendere rapidamente Visibile l'hardware funzionante, quello non testato e quello da testare si consigli l'uso di una tabella con i colori:

  • Verde (lightgreen) -> Funzionante
  • Rosso (red) -> Non funzionante
  • Giallo (yellow) -> Non testato

Un esempio può essere questo:

Ora diamo subito una panoramica sull'opera, in particolare quello che funziona a dovere, e quello che proprio non va:

Componente Funzionante Note
ACPI (video LCD [stand_by - suspend - power_off]) OK
ACPI (Centrino CPU freq. scaling - power states) OK
ACPI (Power Button) OK
ACPI (Lid Switch) OK
ACPI (Thermal Zone - CPU temperature) OK
ACPI (Battery - AC adapter) OK
Intel Corporation Mobile 915GM/GMS/910GML Express Graphics Controller OK Richiede la patch "915resolution" per avere la risoluzione di 1280x768 e gli snapshot dei DRI per abilitare il direct rendering.
Synaptics Touch Pad OK
USB Controller OK
Intel Corp. 82801FB/FBM/FR/FW/FRW (ICH6 Family) AC'97 Audio Ctrl. NO Audio permanentemente muto. Problema già segnalato da tempo nella mailing-list di ALSA Project. https://bugtrack.alsa-project.org/alsa-bug/view.php?id=1134
Modem: Intel Corp. 82801FB/FBM/FR/FW/FRW (ICH6 Family) AC'97 Modem  ?? Probabilmente non funzionante per via del driver audio non funzionante.
IDE controller: Texas Instruments PCIxx21 Integrated FlashMedia Ctrl NO Non supportato.
IEEE 1394: Texas Instruments OHCI Compliant IEEE 1394 Host Controller  ?? Non testato.
Network controller: Intel Corporation PRO/Wireless 2200BG OK http://ipw2200.sourceforge.net/
Ethernet controller: Realtek Semiconductor - Kernel module "8139too" OK
IrDA controller  ?? Non testato.
HotKeys OK
Bluetooth OK
Kernel 2.6.16 OK

Inoltre è buona norma segnalare questo articolo su http://tuxmobil.org/ e http://www.linux-laptop.net/ in modo che molte più persone possano fruirne.

Come scrivere uno script

Prima di mettere un articolo in questa sezione è buona norma provarlo sul proprio pc e verificarne la funzionalità. È d'obbligo mettere in risalto se lo script può causare danni al sistema che lo sta facendo funzionare. È buona norma indentare e commentare il testo il testo in modo da facilitarne la modifica e la comprensione da parte del fruitore dello script.

La struttura di base di un articolo su uno script sarà dunque:


Descrizione

In cui verrò specificato cosa fa lo script, a cosa serve e come è stato fatto

Readme

In cui viene spiegato come si installa e come si usa

Script

Lo script vero e proprio, inserito tra i tag <pre> </pre> in modo che sia considerato come codice e non perda indentazione e sia più facilmente copiabile

#!/bin/bash <- specificare il tipo di shell usata
[...]
  • Dipendenze:
  • Data: Data
  • Autore: autore dello script
  • Versione:
  • Autori delle revisioni:

Strumenti personali

Varianti