Jump to content

Help:Style (Magyar)

From ArchWiki
Fordítás állapota: Ez az oldal az angol Help:Style című oldal magyar nyelvre lefordított változata. Utolsó fordítás dátuma: 2026.05.01. Amennyiben a lefordítás időpontja óta az angol nyelvű oldalon történtek újabb módosítások, akkor Ön segíthet hozzászinkronizálni az angolhoz ezt a magyar nyelvű fordítást.

További oldalak az adott témakörben

Ezek a stíluskonvenciók elősegítik a rendezett, szervezett és vizuálisan következetes cikkeket. Kérjük Önt, hogy kövesse őket a lehető legszorosabban, amikor az ArchWiki weboldalt szerkeszti.

Cikkek

Cím

  • A cikkek címeinek Nagy kezdőbetűvel kell kezdődniük, például az "Új oldal címe" helyes, ám az "Új Oldal Címe" már egyáltalán nem helyes. Vegye figyelembe, hogy a tulajdonnévrészként vagy nagybetűs rövidítésként szereplő közönséges szavakat nagybetűvel kell írni, például az "Advanced Linux Sound Architecture" helyes, ám az "Advanced Linux sound architecture" nem helyes írásmód.
    A névterek nem képezik a címek részét, így az "ArchWiki:Example article" helyes, míg az "ArchWiki:example article" nem helyes. Az aloldalneveknek nagybetűvel kell kezdődniük, így az "Oldalam/Aloldalam" helyes, míg az "Oldalam/aloldalam" nem helyes írásmód.
  • Alapértelmezés szerint a címben a témanevet egyes számban kell használni. Többes számban a témanevet akkor kell használni, amikor egy csoportot vagy osztályt képvisel, és főnévnek vagy megszámlálható főnévnek tekinthető.
  • A cikk címében előnyben kell részesíteni a teljes név használatát, kivéve amikor a cikk tárgya elsősorban a rövidített névről ismert. A cikk címében ne szerepeljen egyszerre a teljes név és a rövidítés is (pl. zárójelben), ehelyett használjon átirányítóoldalt a rövidítés oldalán, amely átirányítóoldal már a teljes névvel ellátott cikkre mutat rá.
  • A magyar nyelvre lefordított oldalak címeinek követniük kell a Help:i18n#Oldalcímek irányelveit.
  • További információkért tekintse meg a Súgó:Cikkelnevezési irányelvek című cikket.

Elrendezés

  • Order elements in an article as follows:
  1. Varázsszavak (Opcionális)
  2. Kategóriák
  3. Nyelvek linkjei (Opcionális)
  4. Cikk státuszát jelölő sablonok (Opcionális)
  5. "További oldalak az adott témakörben" szövegdoboz (Opcionális)
  6. Előszó vagy bevezetés
  7. Tartalomjegyzék (Automatikus)
  8. Cikkspecifikus szakaszok

Varázsszavak

  • Viselkedést befolyásoló kapcsolók (és általában minden olyan varázsszó amely megváltoztatja azt, hogy miként jelenik meg vagy viselkedik egy szócikk, de önmagában nem ad hozzá tartalmat) mindig a szócikkek legfelső részére kerüljenek.
Ez a szabály különösen a {{DISPLAYTITLE:title}} és a Template:Lowercase title használatára vonatkozik, amely az előbbit használja.

Kategóriák

  • Minden cikket be kell sorolni legalább egy meglévő kategóriába.
  • Egy cikk több kategóriába is tartozhat, feltéve, hogy egyik sem őse a másiknak.
  • A kategóriákat minden cikk tetején kell feltüntetni, közvetlenül a varázsszavak alatt.
    Megjegyzés Ez eltér néhány más MediaWiki projekttől, például a Wikipédia módszerétől, ahol a kategóriák az oldal alján szerepelnek.
  • Nem lehet üres sor a kategóriák és a szöveg első sora (vagy a meglévő idegen nyelvű linkek) között, mert ez extra helyet hoz létre a cikk tetején.
  • További információkért tekintse meg a Súgó:Kategória című cikket.

Nyelvek linkjei

  • Ha a szóban forgó cikknek a helyi vagy egy külső Arch Linux Wikipédia weboldalon létezik másik nyelvre is lefordított változata, akkor a lefordított változat nyelvi linkjét a szóban forgó cikk kategóriái után, de a szóban forgó cikk szövegének első sora elé kell elhelyezni.
    Kérjük vegye figyelembe, hogy a cikk olvasásakor ezek a nyelvet váltó linkek ténylegesen felül, a cikk bal oldalán, a megfelelő oszlopban fognak megjelenni.
  • Nem szabad üres sorokat hagyni a nyelvet váltó linkek és a cikk szövegének első sora között, mert ez extra helyet hoz létre a cikk tetején.
  • Nyelvet váltó linkek hozzáadásakor vagy azok szerkesztésekor ügyeljen arra, hogy minden, már meglévő lefordított cikknél ismételje meg a műveletet.
  • Egy szóban forgó cikkhez ne adjon hozzá egynél több nyelvet váltó linket.
  • Ne adjon hozzá a szóban forgó cikkhez olyan nyelvet váltó linket amely nyelvet váltó link a cikk saját, önmaga nyelvére váltana.
  • A nyelvet váltó linkeket a nyelvi címke alapján kell ábécé sorrendbe rendezni. Nem szabad sorba rendezni a nyelvet váltó linket azáltal, ahogyan a nyelvet a saját maga nyelvén írják le az adott nyelven. Például a [[fi:Cikk címe]] megelőzi a [[fr:Cikk címe]] linket, még akkor is, ha a "Suomi" a "Français" után következne. Magyar nyelvet szintén ugyanígy a "hu" karakterek alapján rendezzük, nem a "magyar" karakterek alapján.
  • További információért tekintse meg a Súgó:i18n és Wikipedia:Help:Interlanguage links című cikkeket.

Cikk státuszát jelölő sablonok

  • A státuszsablonok (amelyek a teljes szócikkre vonatkoznak) a kategóriák linkjei (vagy ha vannak, akkor a nyelvi linkek) alatt, és a bevezető (vagy ha van, akkor a "További oldalak az adott témakörben" című szövegdoboz) felett kell, hogy szerepeljenek.
  • Azok az állapotsablonok, amelyek a cikk egy adott részére vonatkoznak, a lehető legközelebb kell, hogy elhelyezkedjenek az adott rész fölött, miközben ügyelni kell arra, hogy ne törjék meg a bekezdéseket, kódblokkokat vagy más, már meglévő sablonokat.
  • Mindig kísérje a cikk állapotsablonját néhány magyarázó szó a kijelölt mezőben (példák minden sablon oldalán megtalálhatók), szükség esetén akár vita megnyitásával a vitalapon.

"További oldalak az adott témakörben" szövegdoboz

  • Egyszerű listát biztosít a kapcsolódó (Arch Wiki weboldalán belüli) cikkekről.
  • Opcionálisan elhelyezhető közvetlenül a kategóriák alatt (vagy a nyelvi linkek, illetve a cikkállapotsablonok alatt, amennyiben azok jelen vannak).
  • Kizárólag a Template:Related articles start (Magyar), Template:Related és Template:Related articles end sablonokból állhat. Tekintse meg az irányelveket az említett lapokon.
  • Nem angol nyelvű cikkek esetén használható a Template:Related2 a horgony szövegének a lefordítására.
  • Kérjük Önt, hogy használja a #"További olvasnivaló a témában" című szakaszt a még teljesebb és részletesebb lista megjelentése érdekében, amely szakasz már tartalmazhatja a linkek leírásait, valamint tartalmazhatja az wiki oldalon belüli vagy a wiki oldalon kívüli linkeket is.

Előszó vagy bevezetés

  • Közvetlenül a cikk első szakasza fölött szerepel.
Kérjük Önt, hogy ne hozzon létre == Bevezetés == vagy == Előszó == szakaszt: Hagyja, hogy ezek a szakaszok automatikusan megjelenjenek az első szakaszcím fölött. Ha az adott cikkben elegendő szakasz található, akkor a tartalomjegyzék automatikusan megjelenik az előszó és az első szakasz között.
  • A cikk témáját írja le.
Ahelyett, hogy Ön a saját szavaival (esetleg elfogultan) írná le egy szoftver jellemzését, használhatja a fejlesztő hivatalos leírását, amely általában megtalálható az adott projekt honlapján, vagy az adott szoftver "about" weboldalán (ha létezik ilyen weblap a weboldalon belül). Például a WireGuard című cikk is így csinálja. Továbbá, felhasználhatja a Wikipédia leírását is. Például az ImageMagick című cikk is ezt teszi.

További információkért tekintse meg a Súgó:Cikkbevezetők írása című leírást.

Standard szakaszok

"Telepítés" szakasz
"Ismert problémák" szakasz
  • Az Ismert problémák című szakaszokat olyan ismert hibák vagy használati problémák leírására szoktuk használni, amelyeknek még nincs megoldásuk. Tekintse meg a: #"Hibaelhárítás" szakasz című szakaszt.
  • Használja a szabványos Ismert problémák címet, és helyezze a szerkesztésben lévő cikk elejére.
  • Ha a neten már létezik hibajelentés az ismert problémával kapcsolatban, akkor nagyon ajánlott, hogy adjon meg rá legalább egy linket. Ha nem létezik hibajelentés, akkor Önnek kell jelentenie, így növelve annak esélyét, hogy a hiba kijavításra kerül.
  • Amikor csak lehetséges, tartózkodjon a dátumok vagy verziószámok említésétől. (Például: "A Linux kernel 3.17 még nem támogatja az XYZ eszközt 2014 októberében."). Ehelyett inkább linkeket, például hibajelentéseket adjon meg a további információkhoz.
"Tippek és trükkök" szakasz
  • A Tippek és trükkök című szakaszok a szoftver használatára vonatkozó haladószintű tippeket vagy példákat tartalmaznak.
  • A szabványos Tippek és trükkök címet használja.
  • Alcímekbe kell rendezni a különféle tippeket és trükköket.
"Hibaelhárítás" szakasz
  • A Hibaelhárítás szakaszt használjuk az adott szoftverrel kapcsolatos gyakran ismételt kérdésekhez vagy a gyakori problémák megoldásaihoz. Tekintse meg az #"Ismert problémák" szakasz leírását.
  • Kérjük Önt, hogy ennek a szakasznak a címeként használja a szabványosított Hibaelhárítás elnevezést. Kerülendő gyakori helytelen írásmódok: Hiba elhárítás, Hiba-elhárítás és HibaElhárítás.
  • Ismert hibákkal kapcsolatban Ön ideiglenes megoldásokat is leírhat ebben a szakaszban. Ebben az esetben kötelező, hogy linket is adjon a hibajelentésre (vagy más megfelelő forrásokra, például egy fórumhozzászólásra, amely tartalmazza a leírt megoldást). Ha még nem jelentették a hibát, akkor Önnek kell bejelentenie, így növelve annak esélyét, hogy a hiba megfelelően ki lesz majd javítva.
    Amennyiben lehetséges, tartózkodjon a dátumok vagy verziószámok említésétől. Nagy előnye van annak, hogy külső linkeket, például hibajelentéseket kapcsol össze az olvasók és szerkesztők számára:
    • Az olvasók számára a Wiki nem válik végállomássá: További információt találhatnak a forráshoz közel, amelyet keresési erőfeszítéseik során esetleg elmulasztottak volna.
    • Ez a szakasz ezt a Wikipédiát szerkesztők számára megkönnyíti a takarítást azáltal, hogy csökkenti annak erőfeszítését, hogy a szerkesztők kiderítsék, vajon egy bejelentett hiba még mindig fennáll-e. Ha az olvasó új információt talál, akkor ez akár nagyobb önállósághoz is vezethet és az olvasó könnyen visszatérhet ezen Wikipédia szerkesztéséhez.
"További olvasnivaló a témában" szakasz
  • A További olvasnivaló a témában szakasz a linkeket és a további információforrások listáját tartalmazza.
  • Ez a szakasz egy olyan lista legyen, ahol minden bejegyzés * jellel kezdődik, amely MediaWiki felsorolásjelet hoz létre.
  • Kérjük Önt, hogy a szabványos További olvasnivaló a témában címet használja, és a cikken belül ezt a szakaszt az utolsó helyre helyezze el. Kerülendők más hasonló címek, mint például Külső hivatkozások, További források stb.

Cikkekben az egyes szakaszok címsorai

  • A cikkekben az egyes szakaszok címsorai a kettes szinttől kell, hogy kezdődjenek (==), mert az egyes szint az adott cikk címének van fenntartva.
  • Kérjük Önt, hogy ne hagyjon ki szinteket az alfejezetek létrehozásakor, tehát egy kettes szintű fejezet alfejezete hármas szintű címsort igényel, és így tovább.
  • A címsorok mondatkezdő nagybetűs formát használnak, nem az angol stílusú címformát: Az én új címsorom a helyes. Az Én Új Címsorom nem helyes.
  • Kerülje a linkek használatát a címsorokban, mert megtörik a stílus egységességét, és nem emelkednek ki eléggé. Általában a linkelt szöveg a szóban forgó szakasz tartalmában található meg. Továbbá, az adott szakasz szövegében (nem a címében) Ön használhat egy egyszerű mondatot is a belinkelés érdekében, például:
További információkért tekintse meg a Kapcsolódó cikk című cikket.
Ugyanezen okból kerülje bármilyen HTML vagy wiki markup programkód használatát, beleértve a #Programkód formázása sablonokat. Tekintse meg a Súgó:Stílus/Szövegformázás és az írásjelek helyes használata című cikket.

Formázás

Programkód formázása

  • Használja a Template:ic sablont rövid programkódsorokhoz, fájlnevekhez és elérési utakhoz, beállítási paraméterekhez, változókhoz és egyéb esetekhez, amelyeket inline kell megjeleníteni. Például:
    Futtassa a parancssorban: sh ./helló_világ.sh.
  • Egyetlen kódsor (parancssori bemenet vagy kimeneti kód, illetve fájltartalom) megfelelő keretben való megjelenítéséhez egyszerűen kezdje a sort egyetlen szóköz karakterrel. További részletekért tekintse meg a Súgó:Szerkesztés#Programkód című leírást. Példa:
$ sh ./helló_világ.sh

Helló világ
  • Használja a Template:bc sablont több kódsorhoz (parancssori bemenet vagy kimeneti kód, illetve fájltartalom) annak érdekében, hogy megfelelő keretben jelenjenek meg. Például:
#!/bin/sh

# Demó
echo "Helló világ"
  • Használja a Template:hc sablont, amikor szükséges a parancssori bemenet és a kimenet együttes megjelenítése. Például:
$ sh ./helló_világ.sh
Helló világ
  • Használja a Template:hc sablont, amikor fájltartalmat kell megjeleníteni, és úgy érzi, hogy az olvasóknak nehéz lehet megérteni, melyik fájlra vonatkozik a kód. Ilyenkor a fájlnév a fejlécben is megjeleníthető. Például:
~/helló_világ.sh
#!/bin/sh

# Demó
echo "Helló világ"
  • Beállításfájlhoz hasonló kódblokkok esetén érdemes az olvasót a releváns sorokra összpontosítani, és a környező, nem releváns tartalmat ellipszissel (...) jelölni.
  • További információért és a sablontörő karakterek (például = vagy |) hibáinak elhárításához tekintse meg a Súgó:Sablon című cikket.

Parancssori szöveg

  • Amennyiben Ön cikkszerkesztéskor inline kódot használ (Template:ic), ne jelenítsen meg prompt szimbólumot. Minden megjegyzést a jogosultságokkal kapcsolatban a környező szövegnél kell hozzáadni.
  • Amennyiben Ön cikkszerkesztéskor kódblokkot használ (Template:bc vagy szóközzel kezdődő sorokat használ), akkor használja a $ jelet a normál felhasználói parancsokhoz. Használja a # jelet a root parancsokhoz.
    Megjegyzés Mivel a # jelet szövegfájlokban megjegyzések jelölésére is használják, mindig ügyeljen arra, hogy elkerülje a félreértéseket, általában úgy, hogy leírja: Futtassa a parancsot vagy szerkessze a szövegfájlt.
    • A parancsblokkot bevezető mondatnak általában : jellel kell végződnie.
    • Cikkszerkesztéskor használja a következő írásmódot: 
      # parancs
      Ne használja a következő írásmódot: 
      $ sudo parancs
    • A cikkek szerkesztésekor ne használja a root parancssort együtt a sudo paranccsal. Például így nem helyes a használat: 
      # sudo parancs
    • Amennyiben Ön egy bizonyos parancsot másik felhasználó nevében futtatja, akkor szögletes zárójelben tegye a prompt elé a felhasználónevet: 
      [archie]$ parancs
    • Ugyanabban a parancsdobozban ne adjon hozzá megjegyzéseket. Például: 
      # pacman -S foo  #Telepítse az xyz szoftvercsomagot
    • Cikkszerkesztéskor kerülje a túl hosszú kódsorok írását: Amikor lehetséges, használjon sortörési technikákat.
  • Ne feltételezze azt, hogy a cikket olvasó felhasználó sudo vagy más jogosultságnövelő segédprogramot használ (pl. gksu, kdesu).

Billentyűgombok

  • A billentyűgombok cikkekben történő ábrázolásának szabványos módja a Template:ic sablon használata.
  • A billentyűgombokat kisbetűvel kell ábrázolni: a. A nagybetűk ábrázolásához használja a Shift+a írásmódot, ne használja a Shift+A vagy az A írásmódot.
  • A billentyűgombok kombinációjának helyes ábrázolásmódja a + szimbólum használatával történik, amely szóközök nélkül kapcsolja össze a billentyűgombokat, egyetlen sablonpéldányban: Ctrl+c.
    A Ctrl + c, Ctrl+c, Ctrl-c nem szabványos formák, így azok használata kerülendő.
  • A billentyűgombok sorozatainak helyes ábrázolása lehet bővebb, pl. "nyomja meg a g billentyűt, majd a Shift+t billentyűgomb kombinációt", vagy tömörebb, amikor a billentyűgombokat egy szóközzel választja el külön sablonpéldányokban: g Shift+t.
  • Az alábbiak a szabványos módjai néhány speciális billentyűgomb ábrázolásának:
    • Shift (nem SHIFT)
    • Ctrl (nem CTRL vagy Control)
    • Alt (nem ALT)
    • Super (nem Windows vagy Mod)
    • Enter (nem ENTER vagy Return)
    • Esc (nem ESC vagy Escape)
    • Space (nem SPACE)
    • Backspace
    • Tab
    • Ins (nem INS vagy Insert)
    • Del (nem DEL vagy Delete)
    • PrintScreen
    • Up (nem ↑ vagy Up Arrow) – Hasonlóan a többi nyílbillentyűgomb esetében.
    • PageUp
    • PageDown
    • Fn (nem FN vagy fn) – A funkcióbillentyű, amely sok laptopon megtalálható.
    • Home (nem HOME vagy Beginning)
    • End (nem END)

Megjegyzések, figyelmeztetések, tippek

  • A Note (Magyar) sablont olyan információkhoz kell használni, amelyek valamilyen módon eltérnek attól az információtól, amelyeket az olvasó természetes módon vár el a cikkben. Ez magába foglalja azokat az információkat, amelyek mélyebb tudást adnak valamiről, holott kissé mellékesnek számítanak a cikk szempontjából. Másik példa ennek a sablonnak a használatra, amikor ideiglenes közleményt kell jelezni. Például amikor jelezni kell egy szoftvercsomag nevének a megváltozását.
A Note sablon használható olyan információ kiemelésére is, amely fontos, de könnyen figyelmen kívül hagyható valaki számára, aki új a témában.
  • A Warning (Magyar) sablont olyan helyzetekben kell használni, amikor a leírt eljárás súlyos következményekkel járhat. Például amikor a leírt eljárás nehezen visszafordítható, vagy az operációs rendszer károsodását okozhatja. A figyelmeztetéseknek általában jelezniük kell a legrosszabb forgatókönyveket, valamint azokat a feltételeket, amelyek ezekhez vezethetnek, vagy amely feltételekkel elkerülhetők.
Általánosságban ne éljen vissza a figyelmeztetésekkel: Ha bizonytalan, akkor nagy valószínűséggel Önnek inkább Note sablont kell használnia.
  • A Tip (Magyar) sablon olyan módszert vagy eljárást jelezzen, amely hasznos lehet és előnyöket hozhat valakinek, bár nem szükséges az adott művelet elvégzéséhez, így biztonságosan figyelmen kívül hagyható.
  • Ha kettő vagy több Note, Warning vagy Tip sablonnak egymás után, ugyanazon ponton kell megjelennie a cikkben, akkor célszerű a sablonok szövegeit egyetlen sablonon belül listába rendezni, és célszerű kerülni a sablonok egymásra halmozását, kivéve amikor teljesen különállóak. Például:
Tipp
  • Első példatipp.
  • Második példatipp.

Táblázatok

Tekintse meg az mw:Help:Tables című leírást a szintaxis áttanulmányozása érdekében.

  • A táblázatoknak általában a wikitable osztályt kell használniuk.
  • Az összehasonlító táblázatoknak ezen felül a sortable osztályt kell használniuk.
  • Amikor van értelme, használjon táblázatfejléceket és cellasablonokat.
  • A táblázatfejlécek mondatkezdő nagybetűs formában legyenek.
  • A táblázatmagyarázatok definíciós listát használjanak, és a táblázatok elé kerüljenek.
  • A lábjegyzetek vagy megjegyzések használják a <sup>1</sup>, <sup>2</sup> stb. formát, valamint egy számozott listát a táblázat alatt, ahelyett, hogy Unicode karaktereket alkalmaznának.

Utasítások

Fájlszerkesztési kérések

  • Ahol hasznos lehet, ott hozzáadható egy link a Súgó:Olvasás#Hozzáfűzés, hozzáadás, létrehozás, szerkesztés oldalhoz.
  • Amikor az adott cikkben arról van szó, hogy szöveget kell szerkeszteni a cikk olvasójának, Ön mint a cikk írója ne feltételezzen a cikk olvasójánál konkrét szövegszerkesztőt (nano, Vim, Emacs, stb.), kivéve amikor ez szükséges.
  • Általánosságban ne használjon parancsokat a szövegfájl szerkesztésének implicit kérésére. Például:
echo -e "clear\nreset" >> ~/.bash_logout helyett így kell:
Adja hozzá a következő sorokat a ~/.bash_logout fájlhoz:
clear
reset
Egy gyakori kivétel azok a parancsok, amelyek összetett, rendszerfüggő kimenetet generálnak. Például genfstab -U /mnt >> /mnt/etc/fstab.

Szoftvercsomagok kezelésével kapcsolatos utasítások

  • Minden szoftvercsomagkezelési utasításnál egyszerű kijelentést kell használni példaparancsok helyett.
  • Amikor egy bizonyos cikkben szoftvercsomag-feltelepítést kérünk a cikk olvasójától, ajánlott a szoftvercsomag-feltelepítési kérelem első előfordulási helyénél a feltelepítés linket vagy a feltelepítési link valamilyen változatát (pl. [[install (Magyar)|feltelepített]]) megadni az olvasónak.
  • Az érintett szoftvercsomagot (vagy szoftvercsomagokat, illetve szoftvercsomagcsoportokat) linkelni kell, lehetőleg változatok nélkül (általában olyan végződéssel jelölve, mint -bin, -git, vagy -nightly), kivéve amikor ezek valóban jelentős különbséget hordoznak.
  • Nem natív szoftvercsomag-kezelőkhöz ne adjon meg konkrét utasításokat (pl. Flatpak, make install), bár egy Tipp megadása elfogadható, amikor Ön eltérő szoftvercsomagra mutat. Például amikor a felsőbb szintű támogatás kizárólag az eltérő szoftvercsomagokra vonatkozik.
  • Ön a cikkek írásakor rugalmasságot kap a megfogalmazásban annak érdekében, hogy az adott cikkhez igazítsa a szoftvercsomag-kezelést. További példákért tekintse meg a #Hivatalos szoftvercsomagok című szakaszt.
Hivatalos szoftvercsomagok
  • Cikkek írásakor a hivatalos szoftvercsomagok feltelepítésének említésénél kerülje a pacman parancsok példáinak használatát: Egyrészt, kerülje az egyszerűség kedvéért (ugyanis minden Arch felhasználónak még álmában is tudnia kell a pacman című cikkben leírtakat). Másrészt, kerülje az olyan hibák elkerülése érdekében, mint a pacman -Sy szoftvercsomag, vagy a véget nem érő viták, például a pacman -S szoftvercsomag és a pacman -Syu szoftvercsomag közötti választás miatt. Még ennél is inkább nem javasolt felajánlani az olvasónak a pacman frontend programok vagy burkoló (wrapper) programok használatát.
Ehelyett használjon egyszerű megfogalmazást. Például:
Telepítse fel a számítógépre a szoftvercsomagneve szoftvercsomagot.
Vagy, ha például az alkalmazás neve eltér a szoftvercsomag nevétől:
AzÉnProgramom telepíthető az-én-programom szoftvercsomaggal.
Több szoftvercsomag feltelepítésére vonatkozó utasítás így jelenhet meg:
Telepítse a szoftvercsomagnév1, szoftvercsomagnév2 és szoftvercsomagnév3 szoftvercsomagokat.
Ön a következőt használhatja, amennyiben egy szoftvercsomagcsoportra hivatkozik:
Telepítse a szoftvercsomagcsoportnév szoftvercsomagcsoportot.
  • Használja a Template:Pkg sablont. Például: {{Pkg|szoftvercsomagnév}}.
Ha szoftvercsomagcsoportra hivatkozik, használja helyette a Template:Grp sablont. Például: {{Grp|szoftvercsomagcsoportnév}}.
  • Ha a szoftvercsomag a core vagy extra szoftvercsomag-tárolóban található, akkor ne hivatkozzon a szoftvercsomag-tárolóra: Ez növeli a karbantartási igényt, mivel nem ritka, hogy egy szoftvercsomagot áthelyeznek másik szoftvercsomag-tárolóba. Ha a szoftvercsomag egy hivatalos, de alapértelmezetten nem engedélyezett szoftvercsomag-tárolóban található (multilib, core-testing, stb.), akkor kötelező megemlíteni. Például így:
Telepítse fel a szoftvercsomagnév szoftvercsomagot a hivatalos multilib szoftvercsomag-tárolóból.
AUR szoftvercsomagok
  • Kerülje az AUR szoftvercsomagok feltelepítésének a példáit. Sem a hivatalos módszerrel, sem az AUR segédprogramok megemlítésével ne adjon meg példát a cikk olvasójának. Minden felhasználónak, aki nem hivatalos szoftvercsomagokat telepít fel a számítógépre, el kell olvasnia az Arch User Repository című cikket, és tisztában kell lennie az operációs rendszerére gyakorolt lehetséges következményekkel.
Ehelyett csak egy egyszerű kijelentést használjon, például:
Telepítse a szoftvercsomagneveAUR szoftvercsomagot.
  • Használja a Template:AUR sablont. Például: {{AUR|szoftvercsomagneve}} .
Nem hivatalos szoftvercsomag-tárolók
  • Amikor Ön azt javasolja a cikk olvasójának, hogy a cikk olvasója egy nem hivatalos szoftvercsomag-tárolót használjon annak érdekében, hogy a cikk olvasója egy előre elkészített szoftvercsomagot feltelepítsen a számítógépre, akkor Ön, mint a cikk írója, ne adjon meg a cikkben utasításokat a szoftvercsomag-tároló engedélyezésére, hanem adja hozzá a szoftvercsomag-tárolót a Nem hivatalos felhasználói szoftvercsomag-tárolók weboldalhoz, és a szerkesztett cikkben egy link segítségével hivatkozzon a megfelelő szoftvercsomag-tároló szakaszára. Például: [[Unofficial user repositories (Magyar)#példa|példa]].
  • Ugyanúgy, mint a hivatalos szoftvercsomagok esetében, a nem hivatalos szoftvercsomagok esetében se ne adjon hozzá pacman példaparancsokat. Példa a helyes megfogalmazásra:
Telepítse a szoftvercsomagneve szoftvercsomagot a példa szoftvercsomag-tárolóból.
Akkor is eszerint járjon el amikor a szóban forgó szoftvercsomag elérhető az AUR szoftvercsomag-tárolóból:
Telepítse a szoftvercsomagneveAUR szoftvercsomagot, amely szintén elérhető a példa szoftvercsomag-tárolóból.
Akkor is eszerint járjon el amikor a szóban forgó szoftvercsomag más néven érhető el az AUR szoftvercsomag-tárolóból:
Telepítse a szoftvercsomagneveAUR szoftvercsomagot, amely xyz néven is érhető a példa szoftvercsomag-tárolóból.

A systemd unit-fájlokkal kapcsolatos műveletek

  • Ne adjon példákat arra vonatkozóan, hogy miként kell engedélyezni, elindítani vagy bármilyen más alapvető műveletet végrehajtani a systemctl segítségével a systemd unit-fájlokon. Ehelyett használjon egy egyszerű mondatot, amely felsorolja az érintett unit-fájlokat. Esetleg, említse meg a cikkben az unit-fájlok függőségeit vagy ütközéseket más unit-fájlokkal. Valamint, említse meg a végrehajtandó műveletek leírását. Például:
Annak érdekében, hogy a GDM elinduljon a bootoláskor, engedélyezze a gdm.service szolgáltatást.
Illetve, amikor például az unit-fájl egy sablon, amelyet példányosítani kell:
Egy vezeték nélküli interfészen a netctl profilok automatikus váltásának engedélyezése érdekében engedélyezzen egy példányt a netctl-auto@.service unit-fájlból az interfész nevével. Például netctl-auto@wlan0.service.
Önnek meg van adva a rugalmasság ahhoz, hogy a megfogalmazást az adott cikkhez hozzáigazítsa.
  • Ön ne felejtsen el linkelni a Help:Reading (Magyar)#A systemd unit-fájlok vezérlése weboldalra egy dedikált, erre a célra létrehozott átirányító link segítségével, mint például [[start(Magyar)|elindít]], [[enable (Magyar)|engedélyez]] vagy [[stop (Magyar)|leállít]].

Kódolási stílus

  • Parancsok vagy szkriptek cikkhez történő hozzáadásakor használjon következetes kódolási stílust az egész cikken belül, esetleg hivatkozva más cikkekre is, különösen akkor, amikor vannak kapcsolódó cikkek. Ha lehetséges, akkor tartsa tiszteletben a nyelv hivatalos vagy legelterjedtebb kódolási stílus irányelveit.
  • Kerülje a használt programozási nyelv (szkript nyelv) elavult funkcióit. Például használja a $() szintaxist a shell parancs helyettesítésére a backtick/gravis (``) szintaxis helyett.
  • A szkripteknek csak a minimálisan szükséges feladatot kell elvégezniük a lehető legjobban érthető formában. Nem szabad őket rugalmasságra vagy bővíthetőségre tervezni, inkább használja a pszeudováltozókat tényleges változók helyett. A cikkekben ne adjon hozzá irreleváns funkciókat a például szolgáló kódokhoz. Például argumentumfeldolgozást vagy kimenetformázást ne adjon hozzá.
  • A szkripteket főként oktatási célból kell hozzáadni a cikkhez, amikor a cikk szövegében szereplő részletes magyarázat nem tehető elég világossá és tömörré. Hasznosak lehetnek például annak bemutatására, hogy miként kell egy összetett parancsot használni, vagy hogyan működnek együtt a kapcsolódó vagy egymástól függő parancsok.
  • Ha egy szkript értéket ad a cikkhez, de nem felel meg a fenti kritériumoknak, akkor külső hivatkozásként is megadható, például közzétéve gist formában.
  • Könyvtár nevének megadása vagy elérési útvonal megadása végződjön perjellel, vagy adjon hozzá egy jelzőt (például "könyvtár"). Például:
  • "Ellenőrizze, hogy létrejött-e a /sys/firmware/efi könyvtár" írásmód a helyes. Az "Ellenőrizze, hogy létrejött-e a /sys/firmware/efi" nem helyes.
  • Helyes a "Helyezzen egy .conf fájlt a /etc/modules-load.d/ könyvtárba" megfogalmazás. Helytelen a "Helyezzen egy .conf fájlt a /etc/modules-load.d könyvtárba" megfogalmazás.
  • A szóközt tartalmazó argumentumokat dupla idézőjelek közé kell tenni. Például a cd "valami példa" írásmód helyes. A cd valami\ példa írásmód nem helyes.

Parancssorok

  • Ne feltételezze, hogy a felhasználó egy bizonyos parancssort használ (például Bash). Kizárólag abban az esetben feltételezze, hogy a felhasználó egy bizonyos parancssort használ, amikor a feltételezés valóban szükséges. A cikkek megírásakor vagy a cikkek szerkesztésekor törekedjen a lehető legsemlegesebb parancsértelmezői megfogalmazásra.

Hiperszöveg-metafora

Tekintse meg a Súgó:Szerkesztés#Linkek című leírást a belső linkek, belső wiki-linkek és külső linkek megértése érdekében.

  • Próbálja meg az Ön saját cikkét a cikk szövegében szereplő szavak felhasználásával minél több másik belső cikkel összekapcsolni.
  • Egyedül a már létező cikkekre hozzon létre linket. Amennyiben Ön halott linkkel találkozik, próbálja azt megjavítani. Jelölje meg a Template:Dead link (Magyar) sablonnal az olyan külső linkeket, amelyek halottnak tűnnek.
  • Amikor csak lehetséges, kerülje el az implicit linkek használatát. Használjon inkább olyan utasításokat mint például: "További információkért tekintse meg a systemd című cikket", ahelyett, hogy a "További információkért tekintse meg ezt a cikket" utasítást használná.

Egy linket kétféleképpen lehet használni:

  • Használni lehet mint témára történő hivatkozás. Amikor a link egy kifejezés, amely a folyó szöveg része, és a szokásos nyelvtani szabályok vonatkoznak rá. Szükség esetén használjon linkelési címkét. A belső/belső-wiki linkeknek egy átirányításra kell mutatniuk amennyiben elérhető az átirányítás céloldala.
  • Használni lehet mint oldalra/szakaszra történő hivatkozás. Ne használjon linkelési címkét, és ahol alkalmazva van a cím, ott írja a címet a Template:Lowercase title szerint. Különösen ne rejtse el a # szimbólumot az ugyanazon oldalon belüli szakaszhivatkozásoknál. Például: [[#Hypertext metaphor|Hypertext metaphor]].

Tekintse meg a következő példákat:

Témára történő hivatkozás Oldalra/szakaszra történő hivatkozás
Használjon SSH ügynököt az azonosítás felgyorsítása érdekében. Kövesse az SSH kulcsok#SSH ügynökök című útmutatót az azonosítás felgyorsítása érdekében.
A legtöbb monitor által támogatva van a subpixel rendering. Engedélyezze a subpixel rendering lehetőséget a Font configuration#Subpixel rendering című leírás szerint.
Vegyen fel egy kulcsfájlt az initramfs fájlba. Az utasítások megtalálhatók a dm-crypt/Device encryption#Keyfiles című részben.
Legyen azzal tisztában, hogy az egérbillentyűk le vannak tiltva alapértelmezetten. A részletekért tekintse meg a Wikipedia:Mouse keys című oldalt.
Léteznek stílusszabályok a hivatkozások számára. A #Hiperszöveg-metafora című szakasz stílusszabályokat tartalmaz a hivatkozások számára.
  • Mielőtt egy konkrét eljárást írna le egy cikkben, vagy valamit részletesen bemutatna, mindig ellenőrizze, hogy létezik-e már olyan cikk, amely a szóban forgó részt részletesen tárgyalja. Ilyen esetben inkább hivatkozzon arra a cikkre, ahelyett hogy megismételné annak tartalmát. Továbbá:
    • Az ArchWiki weboldalon nem tárgyalt szakkifejezések esetén hivatkozzon a megfelelő Wikipédia weboldalra.
    • Ha a cikk tárgyához tartozó upstream dokumentáció jól megírt és karbantartott, akkor inkább csak Arch-specifikus adaptációkat írjon, és az általános információkhoz hivatkozzon a hivatalos dokumentációra.
Például: "Bootoláskor a kernelparaméterek rendszerhívások kiadására szolgálnak. A teljes listát megtekintheti a Linux kerneldokumentáció című weboldalon."
Általánosságban Ön tartsa meg az összhangot a Súgó:Olvasás#Szervezés című útmutatóval.
  • Ne hagyjon egy cikket zsákutcás oldalként (olyan cikk, amely nem hivatkozik másik cikkre), vagy árva oldalként (olyan cikk, amelyre egyetlen másik cikk sem hivatkozik). Nagyon ritka esetben szabad csak ilyet csinálni.
  • Ne használjon belső-wiki linkeket ugyanazon nyelvű, lefordított oldalakra a szerkesztett cikkben, mert ezek nem fognak megjelenni a Special:WhatLinksHere oldalakon. Például a [[:hu:Main page]] használata egy magyar cikkben helytelen, míg a [[Main page (Magyar)]] helyes.
    Az ilyen típusú linkek különböző nyelvek között elfogadhatók, mert ez megkönnyítené a cikkek áthelyezését egy külön wikibe (amennyiben a jövőben létrejönne egy külön wiki).
    Végül vegye figyelembe a különbséget ezek és a #Nyelvek linkjei között, amelyeknél nincs kettőspont az elején.
  • Részesítse előnyben a "Wikipedia:" belső-wiki előtagot a rövidebb "w:" előtaggal szemben.

Man súgóoldalak

Támogatott kernelverziók

  • Ne távolítson el semmilyen megjegyzést vagy adaptációt a kernelverziókra vonatkozóan, amelyek nagyobbak vagy egyenlőek a minimumverzióval. Ez a minimumverzió a core szoftvercsomag-tárolóban található aktuális linux-lts szoftvercsomag és a legfrissebb telepítési adathordozó kernelének összehasonlításából adódik.

Nem releváns tartalom

  • Kérjük Önt, hogy ne írja alá a cikkeket, és ne tüntesse fel a szerzőket: Az ArchWiki a közösség munkája, és minden cikk története elegendő a közreműködők elismeréséhez.
    Vegye figyelembe, hogy a források feltüntetése, amelyek felhasználásra kerültek a cikk megírásához, jó gyakorlat: Erre a célra használhatja a "További olvasnivaló a témában" című szekciót.
  • A fájlok feltöltése le van tiltva a normál felhasználók számára, és nem engedélyezett a képek beillesztése a cikkekbe. Alternatívaként Ön beilleszthet külső képekre vagy galériákra mutató linkeket, és ha egyszerű diagramokat kell rajzolnia, akkor használhat ASCII szerkesztőt, például Asciiflow és Template:Text art. Indoklás:
    • Karbantartás: Az Arch gördülő kiadású (rolling release), és a képek megnehezítenék a cikkek frissítését.
    • Szükségesség: Az Arch nem fejleszt és nem tart fenn semmilyen GUI alkalmazást, így nincs szükség képernyőképek megjelenítésére.
    • Moderáció: A szabad kép feltöltés időt igényelne a túlméretezett vagy nem megfelelő képek eltávolítására.
    • Hozzáférhetőség: Támogatjuk a lassú internetkapcsolattal rendelkező, csak szöveges webböngészőt, képernyőolvasót és hasonló programokat használó felhasználókat.
    • Hatékonyság: A képek pazarolják a szerver sávszélességét és tárhelyét.
    • Egyszerűség: A csak szöveges cikkek egyszerűbbnek és rendezettebbnek tűnnek.

Helyesírás

  • Kerülje az összevonásokat: Például a "don't", "isn't", "you've" helyett használja a "do not", "is not" és "you have" alakokat.
  • Kerülje a szavak szükségtelen rövidítését: például a "repo", "distro" és "config" helyett használja a "repository", "distribution" és "configuration" alakokat.
    Ugyanígy, az ritkán használt parancsopciók esetében részesítse előnyben a hosszú formát az egykarakteres megfelelő helyett. Részletekért tekintse meg a Help:Style/Formatting and punctuation#Configuration parameters, variables, options, properties... című leírást.
  • A projektek, alkalmazások, futtatható állományok stb. neveit elsősorban a hivatalos dokumentáció stílusa szerint kell írni, különösen a nagybetűs írásmódra figyelve. Ez vonatkozik arra az esetre is, amikor a dokumentáció köznévként kezeli a nevet (tehát mondat elején nagy kezdőbetűvel, máskülönben kisbetűvel). Ha a hivatalos dokumentáció nem alkalmaz következetes stílust, akkor kövesse az ArchWiki weboldalon már használt stílust. Ha a név nem szerepel az ArchWiki weboldalon, vagy továbbra is következetlenül van írva, akkor válasszon egy stílust, és tartsa azt következetesen az egész cikkben, szükség esetén frissítve azokat az oldalakat is, amelyek említik a nevet. Például a Git esetében dönthet úgy, hogy a projekt/szoftver általános említésekor nagy kezdőbetűvel írja ("Git"), míg a lefordított programra hivatkozva kisbetűvel és dőlt betűvel ("git") írja. Amikor a név nagybetűs írásmódja vitát válthat ki, határozza meg kifejezetten a stílust a cikk vitalapján. További részletek a Help:Style/Formatting and punctuation#Executable/application names című leírásban.
  • Az ArchWiki nem részesít előnyben egyetlen angol nemzeti változatot sem, ugyanazokat az irányelveket követve, mint a Wikipedia:Wikipedia:Manual of Style#National varieties of English. Ütközés esetén az ArchWiki kifejezetten meghatározott irányelvei élveznek elsőbbséget. Új tartalom írásakor egy meglévő cikken belül ajánlott fenntartani az ott már elterjedt helyesírási konvenciót. Tehát, amikor a cikkben nincs egyértelműen uralkodó helyesírás, írjon az adott szakaszban használt változatnak megfelelően. Elfogadható a helyesírás harmonizálása a szerkesztett tartalom körül. Tartózkodjon azonban az olyan szerkesztésektől, amelyek fő célja a cikkek vagy cikksorozatok helyesírási szabványának megváltoztatása vagy harmonizálása.

Nyelvi regiszter

  • A cikkeket formális, szakmai és tömör nyelvezettel kell írni. Ügyeljen arra, hogy a nyelvtani és helyesírási hibákat szerkesztési előnézetek és lektorálás révén javítsa.
  • Ne csak arra adjon választ, hogy hogyan, hanem arra is, hogy miért. A magyarázó információ mindig jobban hozzájárul a tudás átadásához, mint pusztán az utasítás.
  • Ne hagyja ki azokat a kifejezéseket, amelyek szükségesek a mondat pontos, egyértelmű jelentésének megadásához. Például mindig adja hozzá a "szoftvercsomag-tároló" szót, amikor egy szoftvercsomag-tároló nevét említi.
  • Ne használjon határozatlan időbeli hivatkozásokat, mint például "jelenleg", "az írás idején" vagy "hamarosan". Helyettesítse ezeket határozott kifejezésekkel, mint például "2015 májusában".
  • Írjon tárgyilagosan: Ne tegyen személyes megjegyzéseket a cikkekbe. Erre a célra használja a vitafórumokat. Általánosságban kerülje az első személy használatát.
  • Tartalom szerkesztésekor legyen következetes a cikk többi részében használt stílussal. Például amikor az olvasót mindig második személyben szólítják meg, akkor ezt a stílust kell követni az új tartalomnál is. Ugyanígy, amikor harmadik személy vagy passzív szerkezet dominál a cikkben, akkor azt kell fenntartani.
  • Amikor Ön különböző lehetőségek (szoftverek, módszerek stb.) közül kínál választást, ne ajánljon fel kifejezetten egyet a többiek fölé, hanem tárgyilagosan írja le mindegyik előnyeit és hátrányait, így segítve az olvasót a számára legjobb döntés meghozatalában.
  • Részesítse előnyben a semleges névmásokat, mint például they/them, amikor az olvasóra vagy általánosságban emberekre hivatkozik.

Kategóriaoldalak

Oldalak átirányítása

  • Rövidítésekhez vagy egy meglévő cikk címének nyelvtani változataihoz ajánlott átirányítási lapokat létrehozni, illetve olyan kifejezésekhez vagy témákhoz, amelyek egy általánosabb cikk alcímében szerepelnek. Például ALSA, szolgáltatás vagy AIGLX. Az átirányítások egyszerűsíthetik a forrásszöveget a címkézett hivatkozások helyettesítésével. Hasonlítsa össze az előző példákat a következőkkel: [[Advanced Linux Sound Architecture (Magyar)|ALSA]], [[daemons (Magyar)|szolgáltatások]] vagy [[Xorg (Magyar)#Composite|AIGLX]].
  • Az átirányítási lapok kizárólag az átirányítókódot tartalmazzák, semmi mást ne tartalmazzanak. Kivétel ez alól:
  • Egyedül belső cikkekre irányítson át, ne használjon belső-wiki átirányításokat.
Az belső-nyelvi hivatkozásokkal történő átirányítás kivételesen engedélyezett a Súgó:i18n szerint, valamint az ArchWiki:Karbantartói csapat jóváhagyásával.

User lapok

  • Az User névtérben lévő lapok nem kategorizálhatók.
  • Az User névtérben lévő lapok csak más lapokból hivatkozhatók az User vagy talk névterekből, kivéve, amikor az Adminisztrátorok engedélyt adnak más hivatkozásra.
  • A átirányítások más névterekből nem mutathatnak a User névtérben lévő lapokra.

Generic rules

Szerkesztési összefoglaló

Tekintse meg a ArchWiki:Contributing#The 3 fundamental rules című leírást.

HTML elemek

  • A HTML elemek használata általában nem javasolt. Amikor csak lehetséges, előnyben kell részesíteni a wiki markup nyelvet vagy a sablonokat. (Tekintse meg az Súgó:Szerkesztés című oldalt és kapcsolódó oldalak.
  • Amikor <pre>code</pre> használatára lenne kísértés, mindig inkább {{bc|code}} formát kell alkalmazni. Amikor <tt>text</tt> vagy <code>text</code> használatára lenne kísértés, mindig inkább {{ic|text}} formát kell alkalmazni.
  • Különösen kerülni kell a HTML megjegyzéseket (<!-- comment -->): Valószínű, hogy egy HTML megjegyzésben hozzáadott megjegyzés megjeleníthető a cikk vitafórumán. A megjegyzés helyett megfelelő állapotsablon adható hozzá.
  • A <br> használata csak akkor indokolt, amikor az valóban szükséges. Új bekezdés vagy sortörés létrehozásához üres sort kell alatta hagyni.
Tipp Az általános szabály alóli gyakori kivételek közé tartozik, amikor szükséges sortörést alkalmazni egy listaelemben, és nem lehet al elemet használni, vagy egy sablonon belül, ahol nem lehet listát alkalmazni.