SDB:Howto

Probléma

Ez az SDB (support database) cikk leírja, hogyan szerkesszünk SDB lapokat.

Megoldás

Az SDB cikkek egyrészt a SUSE Linuxszal kapcsolatos problémákra adnak megoldást, másrészt bővebb tájékoztatást nyújtanak az egyes témákról. Ha problémája van a SUSE Linuxszal, az SDB az első hely, ahol érdemes körülnézni.

Egy SDB cikk az alábbi fejezetekre tagolódik:

Probléma
Megoldás
Linkek

vagy

Tünetek
A tünetek okai
Megoldás
Linkek

Egy SDB cikknek a lehető legkönnyebb problémamegoldást kell tartalmaznia. Emellett érdemes leírni a leggyorsabb metódust is, ami állhat konzol parancsokból és konfigurációs állományok kézi szerkesztéséből. Ha több módszer is le van írva, a "Megoldás" fejezetet több szakaszra kell felbontani. Mielőtt a részletekbe merülnénk, álljon itt egy - egyelőre angol nyelvű - példa: Changing NTP Server - SDB Example, alább pedig átható a linkelt oldal forráskódja.

A példa forráskódja

<!-- SDB information
SDB:title: Changing NTP Server - SDB Example 
SDB:author: mlasars
SDB:date: 2005-10-17 -->

 Version: 9.0

[[Category:SDB:Network|N]]
[[Category:SDB:9.0|N]]

This article is an example for writing SDB articles.

== Situation ==

You set the clock on your computer using ntp, but the server
you are using is no longer working.

== Procedure ==

This article describes several solutions:

=== with YaST2 ===

Start YaST2, select "Network Services" and start the module "NTP
Client". In "Select" choose "public server". Choose your country from the
list, or one that is closest to you, and in the second panel choose a
different server. Then click "Test", and if the test was successful,
"Ok". Complete the configuration with "Finish".

=== on the command line ===

Open the file <code>/etc/sysconfig/ntp</code> and change the variable
<code>NTPD_INITIAL_NTPDATE=""</code> to the server of your choice. Then
restart ntp with

 rcntpd restart

== Links ==
[[SDB:Time Synchronization Through the Network]]

<keyword>ntp,xntp,time,synchronize</keyword>
[[en:SDB:ntp_server_change(example)]]

Új cikk létrehozása

A böngészője címsorába írja be a létrehozandó cikk nevét az SDB: kulcsszó után (pl. ennek a Howtonak a létrehozásához azt kellett beírni, hogy http://hu.opensuse.org/SDB:Howto). Ha a cikk még nem létezik, kattintson a szerkesztés gombra a létrehozásához. Ne írjon felül meglévő lapokat. Ha mindenképpen újat szeretne ugyanabban a témában létrehozni, adjon verziószámot a cikked címsorához.

Mint a fentiekből kiderül, minten SDB cikknek az SDB: kulcsszóval kell kezdődnie. Ez megkönnyíti a keresést, és így a wikiben is külön kategóriát alkot.

History

Ha végezett egy SDB cikkel, adja hozzá az SDB:History-hoz. A következő formátumot használja:

ÉÉÉÉHHNN [[SDB:<cikk_neve>]]

például:

20071010 [[SDB:Howto]]

A lista csökkenő időrendben van, tehát a legújabb cikkek vannak legfelül.

Ha nagyobb változtatást végezett a cikkén (pl. frissítetted, hogy illeszkedjen egy új openSUSE verzióhoz), vegye fel a History-ba. Kisebb változtatásokat nem szükséges külön jelezni.

Nyelvek

Jelenleg az openSUSE wiki fő nyelvei az angol, a német, a francia és a spanyol. Ha beszéli valamelyik nyelvet, a cikkét fordítsa le ezekre a nyelvekre is. Ha nem érzei biztosnak a nyelvtudásod, kérjen segítséget a magyar lokalizációs levelező listán.

Ha lefordított egy cikket, a végén cikk végén tüntesse fel az eredeti cikket "Interwiki" hivatkozással. Például ha angolról fordította a cikket, a magyar linkjei közé szúrja be a következő sort:

[[en:SDB:<cikk_neve>]]

Jelenleg a következő hivatkozások használhatók:

de - német
en - angol
fr - francia
es - spanyol

Meglévő cikkek szerkesztése

Az SDB wikibe integrálásával lehetségessé vált az összes cikk szerkesztése. Ha meg szeretne változtatni egy cikket, először beszélje meg az szerzőjével. Használja erre az adott cikk "Vita" lapját.

Bár ez nem kötelező, de megkönnyíti a közös munkát. Ha nem tudnak megegyezni, az opensuse-wiki levelező listán segítenek tisztázni a dolgokat.

Apróbb változtatások (pl. helyesírási, szerkesztési hibák) értesítés nélkül is elvégezhetők.

SDB tag-ek

Tartalomjegyzék

Ha egy cikk három vagy annál több fejezetből áll, a wiki automatikusan tartalomjegyzéket generál hozzá. Ha betartjuk a fent említett hármas tagolást (probléma, megoldás, linkek), akkor nem kell törődnünk a tartalomjegyzékkel.

SDM meta információk

Minden SDB cikk tetjére adja hozzá az alábbi információkat. Ezek a cikkben nem jelennek meg.

<!-- SDB information
SDB:title: A cikk címe
SDB:author: A neved
SDB:date: A létrehozás dátuma -->

Ha nagyobb változtatást végezett egy cikken, a nevét adja hozzá a "title" sorhoz - természetesen az eredeti szerzőt hagyja meg, egy vesszővel válassza el egymástól a neveteket. A dátumot ne változtassa meg! A cikk változásai nyomon követhetők a lap tetején található "Laptörténet" linkre kattintva.

Verzió

A cikk elején kell definiálni, hogy melyik verió(k)ra vonatkozik a cikk. Erre több lehetőség van, például:

Verzió: 10.0
Verzió: - 10.0
Verzió: 10.0 -
Verzió: 10.0 - 10.3

Ha minden verzióra érvényes a cikke, ezt az információt kihagyhatja.

Ha esetleg architektúra-függő a cikked, írja azt is bele:

Verzió: 9.2 x86_64
Verzió: 10.3 ppc

Jelenleg az openSUSE a következő architektúrákat támogatja: i386, x86_64 (64bit, AMD64 és Intel EM64T) és ppc (PowerPC, pl. Macintosh vagy IBM System p).

Ha fontos, a beszerzés módját is írja hozzá (de csak akkor, ha a problémának köze van a terjesztés módjához). Jelenleg az alábbi módokon érető el az openSUSE: Dobozos (a megvásárolható változat), FTP, CD, DVD, Torrent és OSS. Példák:

Verzió: 10.0 DVD
Verzió: 9.0 - 9.3 FTP

Megjegyzés: Ahhoz, hogy a verzió információ be legyen keretezve, kezdje a sort egy szóközzel.

Kategóriák

Minden cikknek elérhetőnek kell lenni kategóriákon keresztül is. A kategóriák a Kategória:SDB lapon találhatók. A kategóriát a cikk elején kell hozzáadni:

[[Kategória:SDB:8.0|C]]
[[Kategória:SDB:Network|C]]

A kategóriát egy cső karakter és a cím első karaktere követi. A fenti példában a cikk neve "Changing NTP Servers", ezért a cső karaktert egy "C" betű követi.

Kulcsszavak

A cikk végén adja meg azokat a kulcssszavakat, amik összefüggésben állnak a cikkel:

<keyword>ntp,time,xntp,synchronize</keyword>

Kulcsszónak bármilyen szó használható.

Szintaxis

A wiki szintaxis mellett a MediaWikiben (ez a site motorja) HTML tageket is használhatunk. A cikk forrásának jobb olvashatósága és a könnyebb szerkesztés érdekében azonban amikor csak lehet, használjuk a hagyományos wiki jelöléseket. További információt a lap alján taláható linkeken keresztül érhet el.

Fejezetek

1. szintű: == Fő fejezetek == (a Probléma, Megoldás, Linkek tagoláshoz)
2. szintű: === Alfejezet === (pl. megoldás YaST2-vel, parancssorral)
3. szintű: ==== Még egy szekció ==== (pl. megoldás különböző verziókban)

A Probléma, Megoldás, Linkek fejezeteknek mindig 1. szintűeknek kell lenniük.

Formázás

A bekezdéseket nem kell a HTML-ben megszokott jelölőkkel (<p>bekezdés</p>) határolni, ez automatikusan megtörténik, ha a bekezdések között egy üres sort hagy, amint az az alábbi példában látható:

Wiki jelölő

Megjelenítés

  
Ez az első bekezdés,
amit akár több sorban is írhatunk.


Ez a második bekezdés.

Ez az első bekezdés, amit akár több sorban is írhatunk.

Ez a második bekezdés.

Szöveg (félkövér, dőlt, kód)

Bekezdések vagy szavak kiemelésére az alábbiak használhatók (megjegyzés: aposztrófokat használunk, nem idézőjelet):

Stílus	Wiki jelölő	Megjelenítés
Félkövér	'''Csak ritkán és fontos bekezdések/szavak kiemelésére használja.'''	Csak ritkán és fontos bekezdések/szavak kiemelésére használja.
Dőlt	''Példa a dőlt betűkre''	Példa a dőlt betűkre
Kód	Parancsok és változók jelölésére használja ezt: <code>rcapache2</code>	Parancsok és változók jelölésére használja ezt: `rcapache2`

Számozott és számozatlan listák

Példák listákra:

Wiki jelölő	Megjelenítés
* Bolygók Mars Föld *** Hold	Bolygók Mars Föld Hold
#Utazás ## Repülő ## Autó ### Taxi	Utazás Repülő Autó Taxi

A cikk végén található linkeknél használjon mindig a * Link szintaxist, ne csináljon további tagolást.

Parancsok és konfigurációk

Az egy parancsból álló sorok kiemeléséhez kezdje a sort szóközzel:

rcapache2 restart

A normál szövegbe illesztett parancsokhoz a <code>parancs</code> használandó.

Források és konfigurációs fájlok megjelenítéséhez használja a következő megoldást:

Wiki jelölő

Megjelenítés

<pre>
## Path:        Network/Remote access/SSH
## Description: SSH server settings
## Type:        string
## Default:     ""
## ServiceRestart: sshd
#
# Options for sshd
#
SSHD_OPTS=""
<nowiki>

</nowiki>

</pre>

## Path:        Network/Remote access/SSH
## Description: SSH server settings
## Type:        string
## Default:     ""
## ServiceRestart: sshd
#
# Options for sshd
#
SSHD_OPTS=""

nowiki

Bizonyos helyzetekben szükség lehet a wiki jelölés kikapcsolására:

Wiki jelölő	Megjelenítés	Megjelenítés "nowiki" nélkül
<nowiki>nem '''félkövér''', nem ''dőlt''</nowiki>	nem '''félkövér''', nem ''dőlt''	nem félkövér, nem dőlt

Linkek

Az SDB cikkekre mutató linkek "SDB:"-vel kezdődnek: [[SDB:Howto]]. Lehetőség van egy cikk adott fejezetére is lépni, pl. [[SDB:Howto#Szintaxis]], ami így fog megjelenni: SDB:Howto#Szintaxis. Célszerű lehet címkét adni a linkhez: [[SDB:Howto#Szintaxis|Szintaxis]], ami így fog megjelenni: Szintaxis.

Külső hivatkozásoknak érdemes címkét adni, így egyrészt rövidebb lesz a link, másrészt nem mindig egyértelmű, hogy mire mutatnak.

A [http://hu.opensuse.org openSUSE] így fog megjelenni: openSUSE. Ebben az esetben a linket és a címkét egy szóköz választaja el.

Vegye figyelembe, hogy egyes országokban tilos olyan linkeket elhelyezni, amik sérthetik a helyi törvényeket. Például Németországban tilos olyan szoftverre hivatkozni, amivel másolásvédelmi technológiák kerülhetők meg. Ha nem biztos egy linkkel kapcsolatban, kérdezze meg az opensuse-wiki levelezési listán (lásd Kommunikáció).

Táblázatok

Lásd http://hu.wikipedia.org/wiki/Wikipédia:Hogyan_szerkessz_lapokat?#Táblázatok.

Képek

Mostanáig az SDB cikkek nem tartalmaztak képeket. Kérjük, csak szükség esetén használjon képeket, hogy az ne befolyásolja az oldal kinézetét és a cikk menetét. Ha lehetséges, tegyen egy előnézeti képet a cikk jobb margójára. A képek feltöltéséről további információ a Segítség:Képek oldalon található.

Stílus

Az olvasók megszólítása

A cikkeknél általában magázódó megszólítást használunk, ahogy az a dokumentációban is van. Az angol nyelvű cikkekel természetesen nincs gond a megszólítással. ;)

Terminológia

Sokszor nehéz cikket írni az angol technikai kifejezések nélkül. Itt az arany középút szabálya érvényes, vagyis a magyarba beépült szavakat nyugodtan használja, de ne erőltesse a fordítást minden esetben. Kérdéses esetekben jó kompromisszum lehet mindkét nyelvet használni, például: "...kiolvashatjuk a rendszer naplóból (System Log)."

Érthetően

Még ha az Ön számára a konzol használata könnyebbnek és gyorsabbnak tűnik is, vannak kezdő Linux felhasználók, akikre szintén gondolni kell egy cikk írásakor, ezért - ha lehetséges - mindig írja le, hogyan lehet az adott problémát YaST-tal vagy más, könnyen használható eszközökkel megoldani.

Egy jó SDB cikk minden kis lépést leír, ezért ne az alábbit írjuk:

Az "/etc/inittab"-ban állítsa az alapértelmezett futási szintet 3-ra.

Sokkal inkább így:

Lépjen be rootként és nyissa meg az /etc/inittab fájlt a megszokott szerkesztőjével (pl. vi vagy mcedit).
Változtassa a id:5:initdefault: sort id:3:initdefault:-ra, így a rendszer nem fogja a boot folyamat alatt 
elindítani a grafikus interfészt.

Ez nem túl nagy kérés, azonban rengeteget jelent a kezdő Linux felhasználóknak.

Karbantartás

Az újabb openSUSE verziók megjelenésével szükséges lehet az SDB cikkét az újabb verzióhoz igazítani. Ha a változások túl nagyok, akár egy új verziójú cikket is lehet írni. Kérjük, a cikkét tartsa karban. Ha például az új openSUSE verzióra már nem érvényes a cikk, változtassa meg a verziószámot.