--=REKLAMA=--

Joomla!WikiPL

Nazewnictwo artykułów

Z Joomla!WikiPL

Wersja Zwiastun (dyskusja | edycje) z dnia 00:00, 26 gru 2013

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)

Wstęp

Nazewnictwo

Każda strona na Joomla!WikiPL jest

  • albo samodzielnym artykułem lub poradnikiem,
  • albo rozdziałem poradnika lub częścią artykułu,
  • albo porcją informacji (urywkiem, fragmentem).

Strony - rozdziały oraz strony - "porcje" mogą być wykorzystane dokładnie w takim samym kształcie wykorzystana w innych artykułach czy poradnikach.

Pierwsza rzecz, którą trzeba rozważyć, to tytuł artykułu lub tytuł poradnika oraz tytuły rozdziałów.

Tytuły artykułów i poradników

Krótko, prosto i jednoznacznie

Każdy poradnik powinien mieć możliwie krótką nazwę - tytuł, który prosto i ściśle określa jego zawartość. Najlepiej, aby tytuł zawierał tylko nazwę poruszanego zagadnienia albo nazwę rozszerzenia, któremu jest poświęcony, np.: Komentarze lub AcoComment, Fora dyskusyjne lub Forum Fireboard, itp. Jeśli poradnik poświęcony jest różnym rozwiązaniom, zastosujemy tytuł ogólniejszy, a więc np. Księgi gości, jeśli poświęcony jest konkretnemu rozszerzeniu, użyjemy w roli tytułu nazwy składnika, np. AkoBook.

Ograniczenie - niedozwolone znaki

W tytułach nie stosujemy znaków, które w oprogramowaniu MediaWiki mają specjalne znaczenie, takich jak:

  • dwukropek - :, który ma w MediaWiki specjalne znaczenie,
  • hash - # (krzyżyk),
  • znaków dodawania i odejmowania
  • znaku ukośnika (slasha), gdyż tworzy on podstronę.

Błędna kapitalizacja

W tytułach artykułów, poradników i innych utworów wielkie litery stosujemy zgodnie z ogólnymi zasadami - w wyrazie rozpoczynającym tytuł i w nazwach własnych. Tylko w tytułach czasopism obowiązuje wyjątkowa reguła. Piszemy więc Księgi gości, a nie Księgi Gości (ale - Forum Fireborad).

Na ten sam temat

Powinniśmy unikać takich przypadków, ale może się zdarzyć, że powstaną dwa podręczniki na ten sam temat. Jeśli rzeczywiście nie da się ich połączyć, trzeba ustalić obu podręcznikom tytuły, które by je odróżniały, np. dodać po spacji "przydomek" typu stosowanie, korzystanie, podstawy, dla nowicjuszy, dla administratorów

Nazwy rozdziałów - przynależność i rozdzielanie tytułów

Jeśli artykuł należy do jakiegoś poradnika lub szerszego zwartego opracowania, tytuł powinien odzwierciedlać tę przynależność.

Nazywanie strony "Spis treści", "Dodatek", "O autorach" powoduje, że nie wiadomo, do jakiego poradnika dana strona należy. Aby tego uniknąć, nazwy stron na Joomla!WikiPL powinny pokazywać, gdzie przynależy dany artykuł. Na przykład napotykając stronę Forum Fireboard/Instalacja wiemy od razu, że należy do poradnika Forum Fireboard.

Konwencja ukośników

W nazwach rozdziałów korzystamy z konwencji ukośników, wykorzystującej znak prawego ukośnika (slash) - '/', który w oprogramowaniu MediaWiki automatycznie tworzy podstronę. Podstrony mają samoistnie generowane linki do stron macierzystych, jak na przykład w Joomla!WikiPL:Nowy podręcznik miesiąca/głosowanie wrzesień 2008. Oto przykłady tytułów:

  • [[Artykuł]]
  • [[Poradnik]]
  • [[Poradnik/Rozdział]]
  • ewentualnie również [[Poradnik/Rozdział/Podstrona]]

Pamiętaj jednak o tym, że nazwy stron nie mają odzwierciedlać spisu treści - ani w sensie kolejności (nie powinny zawierać numerów) ani hierarchii (pokazując, że rozdział jest częścią większej części podręcznika).

Dodatkowo, możliwe jest krótsze pisanie linków. W artykule Książka możemy zamiast linku [[Książka/Rozdział|Rozdział]] wstawić [[/Rozdział|Rozdział]] albo [[/Rozdział/]]. Inne skrócone linki to: [[../Inny/]] (link do innego rozdziału na tym samym poziomie) oraz [[../]] (link do głównej strony podręcznika z jego rozdziału).

Hierarchia rozdziałów

Nie tworzymy skomplikowanych, wieloczęściowych nazw rozdziałów. Struktura poradników powinna być możliwie najbardziej płaska. Na przykład zamiast Fireboard/Instalacja/Wymagania instalacyjne lepiej zatytułować rozdział Fireboard/Wymagania instalacyjne. Nazwy trzyczęściowe można stosować wówczas, gdy istnieją strony podsumowaujące każdy dział (zobacz na Wikiboks: Matematyka dla liceum.

Szablony i grafiki

Grafiki i szablony używane w całym serwisie używają prostych nazw:

  • [[Szablon:Uwaga]]
  • [[Grafika:25%.png]]
  • [[Grafika:10_tpl_config.png]]
  • [[Grafika:15_tpl_config.png]]

Natomiast szablony i grafiki ściśle związane z danym poradnikiem powinny zaznaczać, że są jego częścią.

Dobrze:

  • [[Szablon:Fireboard/Parametr]]
  • [[Grafika:Fireboard-Okładka.jpg]]

Źle:

  • [[Szablon:Fireboard parametr]]

Aneksy

Aneksy do poradników, które mogą być wykorzystane w innych poradnikach, rozpoczynamy ciągiem znaków "Aneks". Tytuł aneksu ma być możliwie treściwy i najdokładniej odnoszący się do omawianego zagadnienia. Należy unikać zwyczajowych określeń.

Definicję aneksu "Aneks" i tytuł aneksu przedzielamy znakiem spacji.

Przykłady:

Ułatwienia

Użycie konwencji ukośników znacznie ułatwia pisanie spisu treści. Zamiast pisać odnośnik [[Poradnik/Rozdział|Rozdział pierwszy]] można napisać [[/Rozdział|Rozdział pierwszy]]. Można też napisać jeszcze krócej: [[/Rozdział/]].

Można też użyć krótkich linków do innych rozdziałów: na stronie Poradnik/Rozdział1 możemy dać link do Poradnik/Rozdział2 w ten sposób: [[../Rozdział2/]].


Zobacz też