Szerkesztő:Bináris/Formai útmutató (kódok)
 |
Ez egy esszé. Nem feltétlenül a konszenzust tükrözi, csak a megalkotói véleményét; a célja az, hogy ugyanazokat az érveket ne kelljen újra és újra elismételni. Ha egyetértesz az alapvető mondanivalójával, nyugodtan módosíthatod vagy átfogalmazhatod. Ha nem értesz egyet vele, írd meg egy külön esszében a saját véleményedet, és linkeld be a lap aljára. |
{{javaslat}}
 |
Az oldal tartalma dióhéjban: A jól szerkesztett forráskódok könnyebben olvashatók, javíthatóak, és felesleges bosszúságtól kímélik meg a szerkesztőket. A kódokat emberek és programok egyaránt olvassák és módosítják, ezért úgy célszerű formázni őket, hogy mindenkinek érthetőek legyenek. Ebben sokat segít a programozók által felhalmozott tapasztalat, a programkódokhoz készített stilisztikai útmutatók, amelyek mintájára ez az ajánlás készül. |
Ez az útmutató azoknak a kódoknak a formázását tárgyalja, amelyek csak szerkesztési nézetben láthatóak eredeti állapotukban, az olvasó pedig az eredményüket látja.
Az itt leírtaknak más útmutatóknál kevesebb gyökerük van, csak hosszú idő alatt tudnak átmenni a gyakorlatba, és nincs közvetlen hatásuk a cikkek kinézetére, ezért nem lehet őket kikényszeríteni, és nem célszerű számonkérni valakin, ha nem alkalmazza őket. Az útmutató célja egy olyan sztenderd létrehozása, amely
- „jó lenne, ha”, „próbálj törekedni rá” útmutatásként jelenik meg a szerkesztők előtt, és idővel átmegy a köztudatba
- megjelenik a sablondokumentációk, segítségoldalak másolható mintáiban
- botos javítások alapjául szolgál.
Az útmutató viszonya más útmutatókhoz
[szerkesztés]A Wikipédia:Formai útmutató a cikkek olvasó számára látható megjelenését tárgyalja, ez az útmutató pedig a szerkesztés közben látható forrásnézetét. Tehát nincsenek átfedésben és ellentmondásban sem.
A Wikipédia:Szócikkek felépítése a szócikk részeinek sorrendjét tárgyalja. Ez az útmutató minimális átfedésben van vele.
Áttekintés
[szerkesztés]Kettős természet → Szerkesztő:Bináris/Kettős rendszer Style guide
A kód érthetősége
[szerkesztés]- Az eredmény legyen látható a forrásban
- pl. rejtett {{élő}}, {{szülhal}}, sablonból eredő kategória
A szöveg tagolása
[szerkesztés]Egyéb:sorvégi szóköz, üres sor (pl. képeknél)
br helyett *, poem, pre, syntaxhighlight
Sablonok, alsablonok
[szerkesztés]26032911 Soha: https://hu.wikipedia.org/w/index.php?title=SpVgg_Gr%C3%BCn-Weiss_Deggendorf&action=edit • https://hu.wikipedia.org/w/index.php?title=Christopher_Ryan&diff=prev&oldid=26705819
Táblázatok
[szerkesztés]Kategóriák
[szerkesztés]Utolsó bármilyen sor (portál, csonksablon, nemzetközi katalógusok stb.)
{{külföldi név}}
{{DEFAULTSORT:Névelőnélkülicímegyben}}
[[Kategória:Jóskák és Pisták]]
[[Kategória:Kategorikus tiltakozások]]
[[Kategória:Üvegszemek|Columbo]]
[[in:terwki]]
A kategóriák forráskódját a szoftver meglehetősen lazán kezeli, azaz sokféle rosszul írt kódból lesz jó eredmény. Mégis van egy természetes mód, amelytől nincs okunk eltérni.
- Láthatóság
- Fontos, hogy az olvasók számára megjelenő tartalmi kategória látható és módosítható legyen. Összhangban a Wikipédia:Sablonok készítése oldallal a kategóriát kifejezetten helyezzük el a forráskódban, nem sablonok közvetítésével. (Nem okoz problémát a rejtett karbantartó kategóriák beillesztése sablonokkal.)
- Elhelyezés a szövegben
- A kategóriákat egy kupacban, a szöveg legvégén helyezzük el, soronként egyet. A kategóriák blokkjába tartozik (ebben a sorrendben):
- a ritkán használt
{{külföldi név}}(?) sablon (mely a botok számára fontos, és a DEFAULTSORT tartozéka) - a DEFAULTSORT
- maguk a kategóriák (ezeknek a sorrendjéről nincs konszenzus).
- a ritkán használt
- A blokkot üres sorral választjuk el az összes előtte levő tartalomtól, de magán a blokkon belül nincs üres sor.
- A kategóriák után már csak a ma már nagyon ritkán használt interwikik következhetnek, szintén üres sorral elválasztva a kategóriablokktól. Általában azonban a kategóriákkal végződik a lap.
- Minden sor enterrel végződik, a legutolsó is (azaz a lap utolsó karaktere egy új sor).
- Szintaktikai tudnivalók
- A DEFAULTSORT szót eredeti alakjában írjuk. Létezik magyar fordítása, de nem terjedt el, és mivel mindenki ismeri, nem érdemes kétféle alakot keverni.
- A Kategória szót magyarul írjuk, nagy K-val.
- A kategória neve nagybetűvel kezdődik (számjegy esetén ez nyilván nem szempont).
- Felesleges szóközök sem a sor elején és végén, sem a zárójeleken belül, sem a kettőspont körül nincsenek. Több szóból álló kategórianév vagy rendezőkulcs esetén egyszeres szóközök vannak a szavak között. A szóközöket nem helyettesítjük aláhúzásjellel.