Pomoc:Edycja kodu

Pomoc
Edycja kodu

Edycja kodu

Poniższa strona zbiera przydatne informacje na temat edycji kodu w portalu Wikibooks. W trakcie przeglądania jej warto zaglądać na stronę, poświęconą edytowaniu artykułów.

Brudnopis

Brudnopis to miejsce, w którym możemy swobodnie eksperymentować i dokonywać własnych edycji. Można się do niego dostać klikając tutaj (Wikibooks:Brudnopis).

Nagłówki

Aby stworzyć nagłówek wystarczy na początku i na końcu danej linii dodać kilka znaków "=", a między nimi umieścić tekst, który chcemy, aby został zawarty w nagłówku. Ilość znaków "=" zależy od tego, z którego poziomu nagłówka chcemy skorzystać (mamy 6 poziomów nagłówków do dyspozycji). Przyjęło się, że:

• nagłówek 1-stopnia odnosi się do części,
• nagłówek 2-stopnia odnosi się do rozdziałów,
• nagłówek 3-stopnia odnosi się do podrozdziałów.

Pozostałe nagłówki stanowią jeszcze mniejsze podczęści i są rzadziej wykorzystywane.

Przykład:

== Rozdział ==
Powyższy nagłówek odnosi się do rozdziału.
=== Podrozdział ===
Powyższy nagłówek odnosi się do podrozdziału.
==== Część podrozdziału ====
Powyższy nagłówek jest nagłówkiem 4 poziomu.

Otrzymamy:

Rozdział

Powyższy nagłówek odnosi się do rozdziału.

Podrozdział

Powyższy nagłówek odnosi się do podrozdziału.

Część podrozdziału

Powyższy nagłówek jest nagłówkiem 4 poziomu.

Akapity

Akapity tworzy się bardzo łatwo. Wystarczy tekst akapitów oddzielić pustą linią. Nie wykorzystujemy do tego specjalnych znaczników HTML-a (w szczególności nie zalecane jest korzystanie ze znacznika <p>).

Przykład:

To jest akapit pierwszy.

To jest akapit następny.

Ponadto dany akapit nie musi być pisany
ciurkiem
w jednej linii.

Otrzymamy:

To jest akapit pierwszy.

To jest akapit następny

Ponadto dany akapit nie musi być pisany ciurkiem w jednej linii.

Nowe linie

Aby wymusić przejście do nowej linii nie tworzymy nowego akapitu, ale korzystamy ze znacznika <br />. Ważne jest, aby nie nadużywać konieczności wstawiania nowych linii. Wstawiamy je tylko wtedy, gdy jest taka potrzeba.

Przykład:

Ten akapit nie jest długi, <br />
ale chcemy, aby ten tekst znalazł się w nowej linii.

Otrzymamy:

Ten akapit nie jest długi,
ale chcemy, aby ten tekst znalazł się w nowej linii.

Linki wewnętrzne

Linki wewnętrzne możemy stworzyć w następujący sposób:

• [[link]]
• [[link|opis]]
• [[/podstrona/]]

Przykład:

Link [[Japoński]] wskazuje na stronę główną podręcznika do języka japońskiego. Link
do [[Wikibooks:Bar|Baru]] wskazuje na miejsce, gdzie użytkownicy mogą rozmawiać
o jakiś kwestiach dotyczących całego projektu, jednak w linku zamist napisu "Wikibooks:Bar"
widzimy napis "Baru". Ponadto link [[/Podstrona/]] linkuje nas do niestniejącej podstrony
tej strony.

Otrzymamy:

Link Japoński wskazuje na stronę główną podręcznika do języka japońskiego. Link do Baru wskazuje na miejsce, gdzie użytkownicy mogą rozmawiać o jakiś kwestiach dotyczących całego projektu, jednak w linku zamist napisu "Wikibooks:Bar" widzimy napis "Baru". Ponadto link Podstrona linkuje nas do niestniejącej podstrony tej strony.

Linki zewnętrzne

Linki zewnętrzne tworzymy w dwojaki sposób:

• w nawiasach kwadratowych podajemy tylko adres:

[http://cos-w-sieci.pl]

• w nawiasach kwadratowych podajemy adres, a po spacji nazwę - tekst odnośnika:

[http://cos-w-sieci.pl Coś w Sieci]

Jeśli po spacji nie podamy tekstu odnośnika (opisu), zobaczymy liczbę oznaczającą numer linku na stronie utworzonego w ten sposób.

Przykład:

[http://www.wikibooks.pl To jest link] z opisem, ale link
[http://www.wikibooks.pl] będzie bez opisu; zobaczymy liczbę w nawiasie kwadratowym.

Otrzymamy:

To jest link z opisem, ale link [1] będzie bez opisu; zobaczymy liczbę w nawiasie kwadratowym.

Skróty

Wikibooks posiada zestaw skrótów, dzięki którym możemy w łatwy sposób dostać się do niektórych najważniejszych miejsc związanych z projektem np. WB:SdU, pełna lista znajduje się w WB:WB.

Linki do innych wiki - projektów

Mamy możliwość tworzyć linki do innych wiki - projektów. Aby stworzyć link do polskich projektów piszemy:

• [[w:Link]], aby otrzymać link do Wikipedii
• [[wikt:Link]], aby otrzymać link do Wikisłownika
• [[s:Link]], aby otrzymać link do Wikiźródeł
• [[q:Link]], aby otrzymać link do Wikicytatów
• [[commons:Link]], aby otrzymać link do Wikimedia Commons
• [[n:Link]], aby otrzymać link do Wikinews
• [[m:Link]], aby otrzymać link do Meta-Wiki

Możemy się odwoływać do różnych wersji językowych dodając skrót związany ze skrótem języka np.:

• [[w:en:Link]], odwołujemy się do angielskojęzycznej Wikipedii
• [[:pt:Link]], odwołujemy się do portugalskiego Wikibooks (należy pamiętać o dwukropku na samym początku)

Jeśli dana strona posiada swój odpowiednik na projekcie innojęzycznym, to możemy dodać tzw. link interwiki w taki sposób:

• [[es:Link]]

Wówczas po lewej stronie w odpowiedniej ramce zobaczymy link wskazujący na stronę w innym języku, a która potencjalnie omawia ten sam temat.

Zobaczmy to na prostym przykładzie:

w = Wikipedia
b = Wikibooks
commons = Commons
m = Meta
n = Wikinews
q = Wikicytaty
s = Wikiźródła
wikt = Wikisłownik

Czyli, gdy robimy link do artykułu w Wikipedii na temat Polski, to wstawiamy komendę: [[w:Polska|Polska]], dzięki czemu uzyskujemy taki link: Polska.

Przekierowania

Czasem musimy zrobić stronę, która będzie przekierowywać czytelnika do strony właściwej. Wówczas używamy komendy:

#REDIRECT [[...]]

Co możemy zobaczyć na przykładzie strony Wikibooks:O Wikibooks, która przekierowuje nas na stronę Czym jest Wikibooks.

Nie należy tworzyć przekierowań do przekierowań, czyli przekierowań podwójnych lub wręcz potrójnych. Strony z podwójnymi przekierowaniami są naprawiane przez administratorów a potem usuwane. Rejestrowane są na specjalnej stronie: Specjalna:Podwójne przekierowania.

Okładki

Zaleca się, aby w okładkach podręczników umieszczać nagłówek z tytułem podręcznika, obrazek, link do spisu treści oraz kategorię i interwiki. Należy tak ułożyć wiki-kod, aby klikając na obrazek czytelnik był kierowany nie na stronę obrazka na Commons, ale na spis treści podręcznika. Służy temu komenda "imagemap", która wygląda następująco:

<imagemap>
Grafika:nazwa pliku|rozmiar|rozmieszczenie|thumb|opis podręcznika
default [[tytuł podręcznika]]
</imagemap>

a na przykładzie Pszczelarstwa:

<imagemap>
Grafika:Buckfast_20070915.JPG|600px|center|thumb|Książka jest podręcznikiem pszczelarstwa.
Obejmuje informacje i porady przydatne w prowadzeniu pasieki.
default [[Pszczelarstwo]]
</imagemap>

można działanie funkcji "imagemap" zaobserwować, gdy się wejdzie na okładkę tejże książki.

Można również zrezygnować z opisu podręcznika a zastosować do obrazka tylko samą ramkę, dzięki zastosowaniu funkcji "frame". Ciekawie to wygląda na przykładzie podręcznika Komputer w praktyce:

[[Grafika:EC1835_C_cut.jpg|center|frame|]]

Wówczas nie stosujemy już komendy "imagemap". Jednakże nie używamy "frame", gdy pierwotny rozmiar grafiki jest zbyt duży. Można jednak zmiksować komendę "frame" z komendą "link", tak by po klinkięciu na obrazek na okładce podręcznika czytelnik był kierowany na spis treści, w taki oto sposób:

[[Grafika:EC1835_C_cut.jpg|center|frame|link=Komputer w praktyce]]

Można również zrezygnować z komendy "frame", dzięki czemu będzie można określić wielkość obrazka na okładce. Zrobiono tak w podręczniku Rachunkowość:

[[Grafika:POL Rachunkowość okładka.svg|center|250px|link=Rachunkowość]]

Generalnie komenda "link=nazwa podręcznika", służąca do tworzenia linkujących obrazków, niewątpliwie ułatwia życie zarówno autorom, jak i czytelnikom Wikibooks.

Tekst pogrubiony

Jeśli chcemy, aby w danym miejscu tekst był pogrubiony, dodajemy przed i za nim trzy pojedyncze cudzysłowy (czyli "'''").

Przykład:

'''Ten tekst''' będzie pogrubiony. Ponadto
'''''tekst''''' może być jednocześnie pogrubiony i pochylony.

Otrzymamy:

Ten tekst będzie pogrubiony. Ponadto tekst może być jednocześnie pogrubiony i pochylony.

Tekst pochylony

Jeśli chcemy, aby w danym miejscu tekst był pochylony, dodajemy przed i za nim dwa pojedyncze cudzysłowy (czyli "''").

Przykład:

''Ten tekst'' będzie pochylony. Ponadto
'''''tekst''''' może być jednocześnie pogrubiony i pochylony.

Otrzymamy:

Ten tekst będzie pochylony. Ponadto tekst może być jednocześnie pogrubiony i pochylony.

Lista nienumerowana

Listę nienumerowaną tworzymy wstawiając "*" na początku kolejnych linii. Jeśli chcemy stworzyć listę zagnieżdżoną, to wstawiamy znak "*" kilka razy.

Przykład:

* Listy są pożyteczne:
** systematyzują tekst
** przejrzyście wyglądają

Otrzymamy:

• Listy są pożyteczne:
  • systematyzują tekst
  • przejrzyście wyglądają

Lista numerowana

Listę numerowaną tworzymy wstawiając "#" na początku kolejnych linii. Jeśli chcemy stworzyć listę zagnieżdżoną, to wstawiamy znak "#" kilka razy.

Przykład:

# Listy są pożyteczne:
## systematyzują tekst
## przejrzyście wyglądają

Otrzymamy:

1. Listy są pożyteczne:
   1. systematyzują tekst
   2. przejrzyście wyglądają

Lista definicji

Poniższy przykład przedstawia, w jaki sposób można tworzyć listę definicji.

Przykład:

; EFnet : największa i najstarsza sieć publiczna IRC, działająca głównie w USA.
; Eggdrop : najbardziej popularny program służący do stawiania botów.
; Epona : pakiet serwisów dodatkowych używany w niektórych sieciach IRC.

Otrzymamy:

EFnet

największa i najstarsza sieć publiczna IRC, działająca głównie w USA.

Eggdrop

najbardziej popularny program służący do stawiania botów.

Epona

pakiet serwisów dodatkowych używany w niektórych sieciach IRC.

Wcięcia

Wcięcia tworzymy wstawiając kilka razy znak ":".

Przykład:

: Wcięcie pojedyncze
:: Wcięcie podwójne
::: Wcięcie potrójne

Otrzymamy:

Wcięcie pojedyncze

Wcięcie podwójne

Wcięcie potrójne

Mieszanie list i wcięć

Zagnieżdżanie list różnych typów jest podobne do zagnieżdżania list tego samego typu.

Przykład:

# Lista numerowana
#* Podlista nienumerowana
#* Znowu podlista nienumerowana
#*: Wcięcie w podliście nienumerowanej
# I znowu lista numerowana

Otrzymamy:

1. Lista numerowana
   • Podlista nienumerowana
   • Znowu podlista nienumerowana

     Wcięcie w podliście nienumerowanej

2. I znowu lista numerowana

Poziome linie rozdzielające

Jeśli chcemy dodać poziomą linię rozdzielającą, wstawiamy cztery lub więcej razy znak "-".

Przykład:

To jest pewien tekst.
-----
I ze względów estetycznych dodaliśmy pewną linię rozdzielającą.

Otrzymamy:

To jest pewien tekst.

---

I ze względów estetycznych dodaliśmy pewną linię rozdzielającą.

Powiększanie liter

Powiększone litery robimy za pomocą komendy <big>.

Przykład:

<big>Wikibooks</big>

Otrzymamy:

Wikibooks

Pomniejszanie liter

Pomniejszone litery robimy za pomocą komendy <small>.

Przykład:

<small>Wikibooks</small>

Otrzymamy:

Wikibooks

Zmiana wielkości czcionki

Oprócz powiększania i pomniejszania liter komendami "big" oraz "small" możemy zmieniać wielkość czionki procentowo, korzystając z komendy "font-size":

<div style="font-size: 75%;">Czcionka na 75 %</div>

co daje taki efekt:

Czcionka na 75 %

Tekst preformatowany

Tekst preformatowany (wcięty, czcionka nieproporcjonalna, wiersze nie będą łamane ani łączone przez przeglądarkę) można uzyskać przez poprzedzenie każdego wiersza spacją:

Przykład:

 To przykład tekstu preformatowanego, który
 w każdej linii jest poprzedzony wcięciem.
 Tekst preformatowany można wykorzystywać np. do prezentacji kodu
 źródłowego pewnego programu.

Otrzymamy:

To przykład tekstu preformatowanego, który
w każdej linii jest poprzedzony wcięciem.
Tekst preformatowany można wykorzystywać np. do prezentacji kodu
źródłowego pewnego programu.

Kody źródłowe programów

Kody źródłowe programów umieszczamy w bloku <syntaxhighlight lang="...">...</syntaxhighlight>.

Przykład:

<syntaxhighlight lang="C">
#include <stdio.h>

int main (int argc, char **argv)
{
  return 0;
}
</syntaxhighlight>

Otrzymamy:

#include <stdio.h>

int main (int argc, char **argv)
{
  return 0;
}

Przydatne szablony

Do najczęściej używanych szablonów należą:

• szablony przedstawiające pewne informacje w ramce:

  {{Uwaga|Tekst uwagi}} zwraca uwagę na pewną sprawę

  {{Infobox|Tekst informacji}} przedstawia pewną informację

  {{Porada|Tekst porady}} przedstawia pewną poradę

• szablony porządkowe:

  {{WEdycji}} pokazuje, że jesteśmy w trakcie edytowania danego modułu

  {{TODO|*co trzeba zrobić}} przedstawia, co jeszcze trzeba poprawić

  {{ek|dlaczego trzeba usunąć}} informuje, że dany moduł trzeba jak najszybciej usunąć

  {{SdU}} oznacza, że dany moduł trafił do Stron do Usunięcia

• szablony nawigacyjne:

  {{Nawigacja|Podręcznik|[[link1|opis 1]]|[[link2|opis 2]]}}, do tworzenia nawigacji korzystamy tylko z tego szablonu

Aby skorzystać z szablonu {{Infobox}} piszemy w taki sposób:

{{Infobox|W ten sposób otrzymujemy ramkę z tą informacją.}}

otrzymując poniższą ramkę.

Szablon {{TODO}} możemy wykorzystać pisząc:

{{TODO|
* strona jest brzydko sformatowana
* strona zawiera dużo błędów ortograficznych i merytorycznych
* trzeba poprawić coś jeszcze
}}

a wtedy otrzymujemy taką tabelkę:

Z pozostałych szablonów korzystamy analogicznie.

---

Powrót do Pomocy Wikibooks

Koniec