„HamWiki:Segítség” változatai közötti eltérés
a (apróbb bővítés) |
a (szintaktika kiemelés) |
||
271. sor: | 271. sor: | ||
Kép feltöltése esetén törekedjünk arra, hogy a lényeg legyen felküldve és a tárhelytakarékosság miatt egy-egy indokolt esetet leszámítva 320x240 pixel méretű képnél felesleges nagyobbat felküldeni. Ezért a képből vágjuk ki a lényeget illetve kicsinyítsük le egy tetszőleges képszerkesztő, például [http://www.gimp.org/ GIMP] képszerkesztő program segítségével. A feltöltött képnek mindig adjunk beszédes nevet, mivel a ''1.jpg'' nem fejez ki semmit a [[Speciális:Imagelist|képlistában]]. Ezáltal nehéz megtalálni a képet, ha másik szócikkbe is be szeretnénk illeszteni. | Kép feltöltése esetén törekedjünk arra, hogy a lényeg legyen felküldve és a tárhelytakarékosság miatt egy-egy indokolt esetet leszámítva 320x240 pixel méretű képnél felesleges nagyobbat felküldeni. Ezért a képből vágjuk ki a lényeget illetve kicsinyítsük le egy tetszőleges képszerkesztő, például [http://www.gimp.org/ GIMP] képszerkesztő program segítségével. A feltöltött képnek mindig adjunk beszédes nevet, mivel a ''1.jpg'' nem fejez ki semmit a [[Speciális:Imagelist|képlistában]]. Ezáltal nehéz megtalálni a képet, ha másik szócikkbe is be szeretnénk illeszteni. | ||
+ | |||
+ | == Forráskódokban közölt algoritmusokhoz: c, perl, python ... szintaktika kiemelés == | ||
+ | |||
+ | <HIGHLIGHTSYNTAX language="c"> /* Példa forráskód */ | ||
+ | int main() { | ||
+ | int a=5; | ||
+ | float c=11.2; | ||
+ | printf("%f\n", a*c); | ||
+ | return 0; | ||
+ | } | ||
+ | </HIGHLIGHTSYNTAX> | ||
+ | |||
+ | És a fenti hatást kiváltó wiki-kód: | ||
+ | |||
+ | <pre><nowiki> | ||
+ | <highlightsyntax language="c"> /* Példa forráskód */ | ||
+ | int main() { | ||
+ | int a=5; | ||
+ | float c=11.2; | ||
+ | printf("%f\n", a*c); | ||
+ | return 0; | ||
+ | } | ||
+ | </highlightsyntax> | ||
+ | </nowiki></pre> | ||
== Kategóriákba sorolás == | == Kategóriákba sorolás == |
A lap 2006. július 8., 22:35-kori változata
Tartalomjegyzék
- 1 Hogyan találod meg a keresett szócikket a HamWiki-ben?
- 2 Hogyan tudod a tudásbázis fejlődését elősegíteni?
- 3 Szerkesztési alapelvek és a wiki-szoftver menüinek ismertetése
- 4 A wiki jelölőnyelve
- 4.1 Fejezetcím, alfejezetcím, al-alfejezetcím
- 4.2 Szövegformázás
- 4.3 Szócikkek közötti hivatkozások
- 4.4 Matematikai képletek szerkesztése (TeX)
- 4.5 Matematikai ábrák szerkesztése (gnuplot)
- 4.6 Kép beszúrása
- 4.7 Forráskódokban közölt algoritmusokhoz: c, perl, python ... szintaktika kiemelés
- 4.8 Kategóriákba sorolás
- 5 További lapszerkesztési információ - haladóknak
Hogyan találod meg a keresett szócikket a HamWiki-ben?
- A bal oldali menüben található keresés mező segítségével. Ez a leghatékonyabb megoldás a keresett információ gyors megtalálásához.
- A lapkategóriák alapján
- A kezdőlapon található tematika alapján
- Szintén a bal oldali menüben található lap találomra. Ez igen jó segítség, ha konkrét cél nélkül szeretnél szócikkeket olvasni.
A jól megírt szócikk pedig telis tele van további hivatkozásokkal. Tehát ha a „fonal egyik végét” elkapod, akkor az adott témakörben a wiki-ben tárolt teljes információ szépen körüljárható. Ez a wiki-rendszerek nagy újítása a klasszikus honlaphoz képest. Ugyanis a klasszikus honlapnál megszoktuk, hogy ritka benne a kereszthivatkozás, inkább úgynevezett fa szerkezetű, azaz fenntről lefelé lépkedünk, majd visszalépünk és egy másik ágba lépve böngésszük. Ezzel szemben a wiki-ben egyik szócikk adja a másikat az adott téma alapos körüljárhatósága érdekében.
Hogyan tudod a tudásbázis fejlődését elősegíteni?
A gyorsabb fejlődés és a szélesebb látókör szellemében íródó szócikkek érdekében szerencsés dolog, ha a rádióamatőrök közül minél többen ...
- elkezdünk írni egy szócikkeket - akár tartalmi tematika szintjén is
- folytatjuk, tökéletesítjük a más által elkezdett szócikkeket
- kategóriába sorolásokban és tartalomjegyzékek írásában szorgoskodunk
- szócikken belüli kereszthivatkozásokat hozunk létre
- segítünk olvashatóbbá formázni a szócikkeket
- a vitalap oldalon keresztül az adott szócikkről a társszerzőkkel értekezünk a még tökéletesebb szócikkek érdekében.
Szerkesztési alapelvek és a wiki-szoftver menüinek ismertetése
A HamWiki célja egy rádióamatőrök által rádióamatőrök számára összeállított tudásbázis létrehozása. A szócikkek szerkesztés során legyünk az alapcélokra tekintettel. Ez azt jelenti, hogy
- a szócikkek témája a rádióamatör forgalmazás, technikai háttérismeret és konstruktőri ismeret témájába illő tartós szócikkek legyenek.
- célszerű mélyebb háttérismeretet adni a HamWiki-n, azonban célszerű ezen háttérismereti információkat egy gyakorlatias felépítésű szócikk mögé helyezni.
- mindezen információkat magyar nyelven közöljük. Aztán a szócikk végén a további információgyűjtés érdekében lehet külső hivatkozásokat elhelyezni.
- a szócikkben érdemes más szócikkekre kereszthivatkozásokat elhelyezni, illetve a szócikk végén kategóriamegjelöléseket tenni. Mindez a navigációt és a téma alapos körüljárását nagyban elősegíti.
- reklámnak és eladó termékeknek a szócikkek közt nincs helye. Azonban a rádióamatőrt segítő - például rádióstalálkozó alkalmával a szálláshelyek telefonszámainak igen.
Néhány kérés, javaslat a szócikk módosítása során:
- Próbáljunk az átláthatóságra és a jó olvashatóságra, jó tagoltságra törekedni, akár a szócikk utólagosátszerkesztésével, darabolásávaé, összevonásával.
- a szócikkekben a bő lére eresztett szövegelés helyett ahol lehet célszerű egy szemléletes ábrát, kapcsolási rajz részletet, blokkdiagramot, stb. elhelyezni. A száraz szöveg csak unalmassá teszi a szócikket, az ábra és az alapján a magyarázat annál inkább érthetővé.
- A tartósság érdekében lehetőleg ne írjunk olyat, hogy a A BURABU 2006.június 10-én ..., inkább minden évben, június 2. hétvégéjén kerül megrendezésre. Egyetlen kivétel ez alól az Aktuális események egyetlen lapja, ahol a konkrét időpontokat véglegesítjük.
- Telefonszámnak az +ország-körzet-kapcsolási szám forma célszerű. Körzetszám elhagyása vagy "06" használata kerülendő.
- A megjegyzéseinket a vita lapra irjuk, ne a nagyjából kész szócikkbe.
- A lap mentése előtt használd az Előnézet megtekintése lehetőséget, és ha úgy néz ki a lap, ahogy szeretnéd, akkor a Lap mentése gombbal el tudod menteni.
- Ha a rendszer közli, hogy lapszerkesztői ütközés történt, ez azt jelenti, hogy amíg a lapot szerkesztetted, addig más is szerkesztette. Így már nem ugyaz a lap, mint amit a szerkesztőablakba kértél. Ha ilyen esemény előfordul, akkor nézzd meg, hogy mit változtattál, másold ki azt a részt magadnak, majd a lap tetején a szócikkre kattintva, majd ismét a szerkesztésre, illeszd be a megváltozott szócikkbe a te változtatásaidat.
- Készíts bemutatkozó oldalt a regisztrált nevedhez. Ajánlott felépítése: fotó rólad, hol élsz, kb. milyen QTH-d van, a rádióamatőr tevékenységek közül mivel foglalkozol, elérhetőséged (email, skype), ha van saját honlapod, annak címe.
Szerkesztést segítő beépített lapok
- Friss változtatások: baloldali menüben is metálálható. Segítségével a legutóbb megváltoztatott lapok nyomonkövetése végezhető.
- Képlista: megmutatja, hogy mely képek fel lettek feltöltve eddig a rendszerbe
- File felküldése: baloldali menüben megtalálható ez a funkció, amely segítségével kép tölthető fel. Kérés: lehetőleg értelmes névvel, és ne 1.jpg, 2.jpg nem kifejező nevekkel.
- Meg nem írt lapok: azok a lapok, amelyekre más szócikkben már hivatkozunk, de még nem lett semmi sem beleírva.
- Szócikk megnyitása esetén a bal oldali menüben található egy Mi hivatkozik erre? menüpont, amely megmutatja, mely másik szócikkből hivatkozunk erre a szócikkre.
A weblapon látható menüpontok ismertetése
A lap tetején található menüpontok
- szócikk: a szócikk, amit módosíthatsz.
- vitalap: Ebbe is beleírhatsz. Célja: ha valamivel nem értesz egyet, közölheted a társszerzőkkel és közös erővel ki lesz javítva.
- szerkeszt: a fenti kettő közül amelyik ki volt választva, annak a szerkesztő ablakba történő előhozása. Lehetőleg a szöveg jobb oldalán látható szerkesztés linket használjuk e helyett (ha van). Az ugyanis csak az adott fejezetet emeli ki a szócikkből szerkesztésre.
- laptörténet: laptörténet. Régebbi lapváltozatok illetve különbségek kiemelése szolgáltatással. Ezáltal nyomonkövethetők a változások.
- átmozgat: Lap átmozgatása más névre. A régi név átirányítódik, ha van rá valahonnan hivatkozás.
- lap figyelése: A megváltozott lapokról kimutatást nézhetsz meg. Csak bejelentkezve működik.
A szerkesztőablak tetején látható ikonok
- vastag betű: példa ( Forrás szövegben: '''példa''' )
- dőlt betű: példa ( Forrás szövegben: ''példa'' )
- belső hivatkozás: példa ( Forrás szövegben: [[példa]] ). Megjegyzés: ha más a szócikk neve, akkor [[más szócikk|példa]] elrendezés a más szócikk-re mutat, de a szövegben a példa szó jelenik meg.
- külső hivatkozás: példa ( Forrás szövegben: [http://www.ham.hu példa] )
- Fejezetcím (a nagy A betűs ikon)
- Kép beillesztése (előtte fel kell tölteni)
- Hang beillesztése (előtte fel kell tölteni)
- Matematikai formulák bevitele (LaTeX szintaktikával Lásd: latex78.pdf 3. fejezetét (31. oldaltól)).
Példa: [math]f=\frac{1}{2\pi\sqrt{LC}}[/math] (Képlet szövegesen leírva: <math>f=\frac{1}{2\pi\sqrt{LC}}</math>) - Ne legyen értelmezve a Wiki jelölőnyelvi szimbólum. Példa: ''' hármas szimpla idézőjel'''
- Aláírás időbélyeggel. Vitalap esetén hasznos.
- Vízszintes szeparáló vonal. Ritkán jól jön.
A lap alján látható 3 lehetőség
- Lap mentése: mentés. Ütközés esetén figyeljünk az időközben más által végzett módosításra.
- Előnézet megtekintése: ajánlott a használata mentés előtt. Így ellenőrizhetjük, hogy jó lett-e a módosított lap kinézete. Utána ne felejtsük el elmenteni!
- Változtatások megtekintése: megmutatja elmentés előtt, mit változtattunk. Ez főleg szerkesztői ütközés feloldásakor jöhet jól, azaz amikor a szerkesztésünk közben valaki más is módosította a lapot.
A wiki jelölőnyelve
Eddigiekben legtöbbünk csak olyan szövegszerkesztővel dolgozott, amely egyfelhasználós volt és alakhűen jelenítette meg a szöveget, a betüméretet egyetlen egérkattintással állította. Ezzel szemben van egy - szintén sokunk által kedvelt - másik elv, amely az a leírónyelv nevet viseli. Ez utóbbit használja a wiki is.
A leírónyelv alapelve, hogy a formázáshoz normál szöveges vezérlő karaktereket, vezérlőszavakat használ. A leírónyelv előnye abban rejlik, hogy nincsenek rejtett formázások benne és minden egyes szövegbeli vagy formázásbeli változtatás a szöveges különbség megjelenítésével a felszínre kerül. Ezért bármilyen hihetetlen, de csoportos szerkesztésre alkalmasabb, mint például egy MS Word-szerű (egyfelhasználós) megoldás.
Azonban nem mindegy, hogy a jelölőnyelv vezérlőkarakterei, vezérlőszavai milyen könnyen jegyezhetők meg. A wiki-ben ezeket megpróbálták a lehető leg könnyebben megjegyezhetőre választani. Erre meg is volt a lehetőség, ugyanis a HTML, amire szoftver megjelenítéskor konvertálja a szöveget, viszonylag keveset tud, így a vezérlőkaraktereknek sem kell túl nagy komplexitás. A HTML egyéb lehetőségeit pedig szükség esetén a HTML leíró nyelvből kölcsönözhetik a haladó felhasználók. Szerencsére erre ritkán van szükség.
A képletek azonban lehetnek igen bonyolultak. Így erre a TeX univerzális dokumentációformázó leírónyelvet használjuk. Ez már sokat tud, így sokkal bonyolultabb. Azonban ha a szócikkbe szövegesen írod be a képletet, biztosan lesz valaki, aki TeX szintaktikára átírja.
Ugyanígy szövegesen definiálhatunk matematikai függvényeket a gnuplot segédszoftver segítségével, amely végeredménye egy szép grafikon lesz.
Alábbiakban a wiki jelölőnyelvének legfontosabb elemei kerülnek ismertetésre, illetve a gnuplot függvényábrázoló alapjai.
Fejezetcím, alfejezetcím, al-alfejezetcím
= Főcím =
== Fejezetcím ==
=== Alfejezetcím ===
==== Al-alfejezetcím ====
Szövegformázás
Új bekezdés
Üres sor hagyása új bekezdést fog létrehozni.
Szókiemelés
A szimpla idézőjel ( aposztróf )
- duplán alkalmazva (''duplán alkalmazva'')
- triplán alkalmazva('''triplán alkalmazva''').
Formázatlan, kiemelt hátterű szöveg
Amennyiben a szöveget nem a sor elején kezdjük el, akkor szürke keretbe foglalva, formázatlan szövegként jelenik meg.
Mint például ez.
Ezt viszonylag ritkán használjuk, mivel az üres soroknál véget ér a szürke háttér.
Ha szürke hátteret akarunk, akkor inkább táblázatot érdemes csinálni például az első sorba írt bgcolor="#e0e0e0" opcióval.
Listák
A listák a sor elején elhelyezett * vagy # vagy : jelekkel kezdődnek. Ezek a jelek tetszőleges kombinációban alkalmazva igen változatos listák készítését teszik lehetővé. Az alábbiakban ezek lesznek ismertetve.
Számozatlan lista: * (csillag jel), számozott lista: # (kettőskereszt). Többszintű lista az előbb ismertetett két alapelem megfelelő sorrendben történő egymás után írásával történik. Fontos megemlíteni, hogy egyazon lista az első üresen hagyott sorig generálódik. Tehát az üres sor egyben a lista végét is jelenti.
Számozatlan 2 szintű példa:
- Első szint: *
- Első szint: *
- Második szint: **
- Második szint: **
Számozatlan-számozott 2 szintű példa:
- Első szint: *
- Második szint: *#
- Második szint: *#
Számozott-számozatlan kétszintű példa:
- Első szint: #
- Második szinten #*
- Második szinten #*
- Első szint: #
- Második szinten #*
- Második szinten #*
A : (kettőspont) tabulálást, a ; (pontosvessző) pedig kiemelést eredményez. Így a
- pontosvessző
- kettőspont
- kettőspont
- pontosvessző
- kettőspont
- kettőspont pontvessző
- kettőspont kettőspont
is egész jól kinéző listát eredményez. Azonban hivatalosan a számozott és a számozatlan listatípus a két alap lista.
Táblázatok
Az alábbiakban egy példán keresztül sajátíthatjuk el a táblázatok alapjait:
Első | Második | Harmadik |
---|---|---|
pelda-1 | pelda-2 | pelda-3 |
pelda-1 | pelda-2 | pelda-3 |
pelda-1 | pelda-2 | pelda-3 |
És a fenti táblázat forráskódja wiki jelölőnyelven:
{| border="1" ! Első !! Második !! Harmadik |- | pelda-1 || pelda-2 || pelda-3 |- bgcolor="lightgreen" | pelda-1 || pelda-2 || pelda-3 |- | pelda-1 || bgcolor="lightgreen"| pelda-2 || pelda-3 |}
Speciális karakterek
A wiki jelölőnyelve sem tud mindent, ezért néha a HTML szintaktikához kell nyúlni.
- soremelés: <br>
- m2 : m<sup>2</sup>
- Ut : U<sub>t</sub>
- ± : ± vagy egérrel átmásolni innen.
- Ω : Ω vagy egérrel átmásolni innen.
- π : π vagy egérrel átmásolni innen.
- μ : μ vagy egérrel átmásolni innen.
- € : € vagy egérrel átmásolni innen.
A fentiek használata néha jól jön, de komolyabb képletek szerkesztéséhez a Matematikai képletek szerkesztése részben ismertetett megoldást célszerű alkalmazni.
Szócikkek közötti hivatkozások
A wiki az egyik szócikk adja a másikat elvre épít. Ezért nagyon fontos az, hogy bármely ismeretlen kifejezést egy azt ismertető szócikkre való hivatkozással lássunk el. Ezért a wiki-ben nagyon egyszerűen, az alábbiakban ismertetettek szerint helyezhetőek el hivatkozások:
- Wiki szócikkre: [[példa]], illetve ha a szócikk címe más, akkor [[Kezdőlap|nagyonkezdőlap]]. Példa: nagyonkezdőlap, mint belső kereszthivatkozás.
- Más URL-re: [http://www.ham.hu érdekes lap]. Ekkor a szövegben az "érdekes lap" szópár fog megjelenni. Példa: érdekes lap
Matematikai képletek szerkesztése (TeX)
A bonyolultabb képletek bevitele Tex (LaTex) szintaktikával történik. Ezt a valóságban egy, a szerverben futó LaTeX fordító kép formátumra fordítja, és a böngésző a képet jeleníti meg. A TeX szintaktika a latex78.pdf 3. fejezetét (31. oldaltól) látható részletesen.
Példa: [math]f=\frac{1}{2\pi\sqrt{LC}}[/math] szövegesen leírva: <math> f = \frac {1} {2 \pi \sqrt{LC} } </math>.
Megjegyzés: ez kicsit bonyolultabb, de ne zavarjon. A szócikk írása során írd nyugodtan, hogy f = 1 / (2 pi négyzetgyők (LC)) és tuti, hogy lesz valaki, aki igen rövid időn belül TeX-re átírja neked. Ez a közös szerkesztés egyik előnyös velejárója.
Matematikai ábrák szerkesztése (gnuplot)
Az ábrákat a gnuplot segítségével matematikai képletek formájában szerkeszthetjük. A gnuplot pedig szintén kép formájában adja ki a webböngészőnek. Példa sin(x)-re és a cos(x)-re:
A fenti ábra gnuplot kódban:
<gnuplot> # Egyedi név legyen az output - mivel egy ilyen nevű képet fog gyártani a wiki. set output 'szinusz_pelda.png' set size 1.2, 0.4 set grid set xlabel "Periodus" set ylabel "Pillanatnyi ertek" plot [-1:1] sin(6.283*x) title "Szinusz fuggveny", cos(6.283*x) title "Koszinusz fuggveny" </gnuplot>
Érdekesség: a * a szorzás, a ** pedig a hatványozás! Azaz x**2 = x^2. Továbbá definiálhatók függvények. Például f(a)=sin(a)*cos(a+1) és a plot részben például f(x+1)+4 szerepel. Bővebben a gnuplot oldalán levő help-ben olvashatunk.
Szintén elmondható, hogy ha nincs kedved vagy elegendő ismereted a gnuplot használatához, akkor a szövegben elhelyezett
-- ide kellene egy szinusz és egy koszínusz függvény ábrázoló matematikai ábra az alábbi paraméterekkel: (és a leírása) --
hatására valaki rövid időn belül meg fogja csinálni a szép ábrát. Ez a közös szerkesztés előnye.
Kép beszúrása
- A baloldali menöben található Fájl felküldése opcióval felküldjük a képet. Képnévnek lehetőleg tömör, de beszédes nevet adjunk. Ez később jól fog jönni.
- Szerkesztőablakban felül a 6. ikon segítségével vagy közvetlen beírva a [[Kép:feluletszerelt_ellenallas.jpg|center]] szöveget illetszettük be a feluletszerelt_ellenallas.jpg-t.
Kép beillesztésnél [[Kép:feluletszerelt_ellenallas.jpg|right|thumb|90px|Ellenállás]] tetszőleges kombinációja is lehet. A "right" a jobbra igazítást, a "thumb" a kicsinített beillesztést, a "90px" pedig a 90 pixeles maximális méretet jelenti. A felirat pedig "Ellenállás" lesz.
A jobb oldalra szánt képet célszerű közvetlen a fejezetcím alá beilleszteni, mivel ekkor az adott fejezet kezdetével egy magasságban lesz a kép teteje. Az Előnézet megtekintése használata mentés előtt mindenképp ajánlott.
Kép feltöltése esetén törekedjünk arra, hogy a lényeg legyen felküldve és a tárhelytakarékosság miatt egy-egy indokolt esetet leszámítva 320x240 pixel méretű képnél felesleges nagyobbat felküldeni. Ezért a képből vágjuk ki a lényeget illetve kicsinyítsük le egy tetszőleges képszerkesztő, például GIMP képszerkesztő program segítségével. A feltöltött képnek mindig adjunk beszédes nevet, mivel a 1.jpg nem fejez ki semmit a képlistában. Ezáltal nehéz megtalálni a képet, ha másik szócikkbe is be szeretnénk illeszteni.
Forráskódokban közölt algoritmusokhoz: c, perl, python ... szintaktika kiemelés
<HIGHLIGHTSYNTAX language="c"> /* Példa forráskód */ int main() {
int a=5; float c=11.2; printf("%f\n", a*c); return 0;
} </HIGHLIGHTSYNTAX>
És a fenti hatást kiváltó wiki-kód:
<highlightsyntax language="c"> /* Példa forráskód */ int main() { int a=5; float c=11.2; printf("%f\n", a*c); return 0; } </highlightsyntax>
Kategóriákba sorolás
A lap végén [[Kategória:KATEGÓRIANÉV]] kifejezéssel kategóriába sorolhatók a lapok. Amennyiben a kategória az előnézet során nem kék, akkor valószínüleg elírás történt, illetve a kategória nincs még létrehozva.
Több kategória bejegyzés is tehető a lap végére. Szokás szerint előbbre a globálisabb, gyűjtőkategóriát, a végére a konkrét alkategóriát írjuk.
A jelenleg használt lapkategóriák a ezen a hivatkozáson tekinthetők meg, a jelenleg még nem kategorizált lapok listája itt latható.
További lapszerkesztési információ - haladóknak
- WikiPédia segítség oldala - nagyon jól használható, tematikus