OpenSUSE stílus útmutató
(OpenSUSE Style Guide szócikkből átirányítva)
Szócikk elnevezése
- A szócikk elnevezése a lap címe is egyben
- Legyen egyszerű
- Ne tartalmazzon feloldhatatlan rövidítéseket
- A szócikk elnevezése ne ismétlődjön címsorként a szócikkben
- Ne hozzon létre új névteret
- A szócikk nagybetűvel kezdődjön
Címsorok
- Használja a = (Címsor) jelölést, és ne a ''' (félkövér) jelölést a fejléc kialakításakor. Így a szócikkhez tartozó tartalomjegyzék automatikusan létrejön a címsorok alapján.
- Az első címsor kezdődjön egyetlen = jelöléssel és ne kettővel ==
- A címsorok használatával megkönnyíthető a szócikk olvasása azok számára, akik annak csak egy részére kíváncsiak.
- Amennyiben a szócikk túl hosszú, érdemes megvizsgálni, hogyan lehet címsorokra és alcímsorokra tördelni.
- A címsorok nagybetűvel kezdődjenek.
- Példa címsorok kialakítására:
=Címsor 1= ==Alcímsor 1.1== ==Alcímsor 1.2== =Címsor 2= ==Alcímsor 2.2== ===Alcímsor 2.2.1=== ====Alcímsor 2.2.1.1====
Jelölések használata
- használja a MediaWiki formázó és jelölő funkcióit a szócikk könnyebb olvashatósága érdekében. A fájlnevek és a paranacsok megjelölését
kötött szélességű betűtípussal írja:
<tt>parancs</tt>
Használja a MediaWiki funkcióit
Csak akkor használjon HTML formázást, ha az elengedhetetlenül szükséges. Használja a MediaWiki formázási funkcióit, hogy a forráskód egyszerű és áttekinthető maradjon. Tekintse át a MediaWiki editing help és a Wikipedia lapot.
Megjegyzések
- Ne írjon megjegyzéseket közvetlenül a szócikkbe.
- Olvasóként érdemes a szócikk vita oldalát használni a megjegyzések elhelyezésére.
- A szócikk írójaként ne helyezzen el figyelmeztető megjegyzést a szócikkben arra vonatkozóan, hogy az nem teljes. Erre használja a {{Nem teljes lapok}} sablonját.
- Néhány eset amikor hasznos lehet elrejteni az olvasó elől a néhány szöveget, pl. táblázatok fejléceiban, vagy cellákban.
- Amennyiben mégis a szócikkben szeretne üzenetet hagyni más szerkesztőknek, akkor megjegyzését a következő két jelölése közé tegye: <!-- és -->.
Például:
Szia <!--Ez a megjegyzés.--> világ!
ami a következőképpen fog megjelenni:
- Szia világ!
Így a megjegyzás csak a HTML vagy a wiki forrás megtekintésekor fog látszani.
Sablonok
A sablonokról többet itt tudhat meg: Sablonok
Ne hízlalja mesterségesen a wikit
- Ne készítsen olyan szócikket, amely nem tartalmaz minimális információt, kívéve azokat a szócikkeket, amelyek az eredeti angol nyelvűre mutatnak.
- Ha úgy találja, hogy szükség van egy oldalra, azt akkor egy meglévő oldalhoz kapcsolódóan linkelheti, ezzel megakadályozva, az Árva lapok létrejöttét.
- Ha legalább 2 link mutat egy nem létezó szócikkre, az automatikusan bekerül a Keresett lapok listájába, ami egyfajta priorítást jelent az oldal elkészítése érdekében.
- Ha ennél is magasabb priorítást szeretne elérni, akkor célszerű feltenni a kívánságlista.