<< ImcPoland

od http://twiki.org/cgi-bin/view/Codev/PolishTranslation

Zasady edycji tekstu w TWiki

Tworzenie stron w TWiki polega na pisaniu zwykłego tekstu - dokładnie tak, jak pisanie listów w poczcie elektronicznej. Nie trzeba znać HTML, chociaż można z niego korzystać. Można również korzystać ze specjalnie opracowanego systemu formatowania, tzw. TWikiShorthand. TWikiShorthand jest bardzo prosty, lecz umożliwia dokładne sformatowanie strony. Ponadto można wykorzystywać tzw. nazwy WikiWordPl, czyli wyrazy, które pozwalają tworzyć automatyczne skróty do innych stron.

Poniżej przedstawiono system formatowania stron TWikiShorthand.

Edycja stron za pomocą TWikiShorthand

pierwszy akapit

drugi akapit

---++ Sushi

---+++ Maguro

*Pogrubiony*

_Pochylony_

__Pochylony i pogrubiony__

=Tekst o stałej szerokości czcionki=

==Tekst pogrubiony o stałej szerokości czcionki==

_Tak pochylamy_,
_Tak nam się nie uda _

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

-------

   * pozycja na liście

      * pozycja na poziomie drugim

   1 Sushi
   1 Dim Sum

   Sushi: potrawa japońska
   Dim Sum: S.F.

| *L* |       *C* | *R* |
| A2  |         2 |  2  |
| A3  |         3 |  3  |
| wielokolumnowa |||
| A4  | następna | następna |

WebNotify

Main.CzytajTo

[[wiki syntax]]

[[Main.TWiki users]]

[[WikiSyntaxPl][składnia]]

[[http://gnu.org][GNU]]

[[http://xml.org XML]]

[[WebHome#NotThere]]

[[#MyAnchor][Skocz]]

#MyAnchor Tutaj

<nop>SunOS

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

[[mailto:a@z.com Poczta]]

[[mailto:b@z.com?subject=Powitanie Witaj!]]

HTML na stronach TWiki

Praktycznie wszystkie znaczniki HTML mogą być użyte do formatowania stron TWiki. Należy jednak pamiętać o kilku szczegółach technicznych.

HTML a TWikiShorthand

• Nie zaleca się stosowania HTML na stronach TWiki przeznaczonych do pracy grupowej. Zamiast tego należy stosować TWiki shorthand, co nie zaśmieca tekstu i ułatwia jego edycję.
• Uwaga: TWiki zaprojektowano do pracy na różnych platformach sprzętowych i dla różnych przeglądarek. W standardowej instalacji TWiki obsługuje język HTML w wersji 3.2. Wpisanie tekstu w kodzie źródłowym HTML, w szczególności znaczników obsługiwanych tylko przez daną przeglądarkę, może zmniejszyć kompatybilność TWiki.

Interpretacja HTML przez TWiki

• Tekst strony w formacie TWikiShorthand jest zamieniany na tekst w XHTML 1.0. Aby utworzyć kopię strony w HTML, należy w przeglądarce włączyć podgląd kodu źródłowego i zachować zawartość strony do pliku.
  • Jeśli zachodzi potrzeba wielokrotnego zapisu strony/stron w formacie HTML, można zastosować wtyczkę TWiki:Plugins/GenHTMLAddon. Umożliwia ona utworzenie katalogu, zawierającego sformatowane wersje stron TWiki wraz z dołączonymi plikami.
• Uwaga: Nawiasy trójkątne: otwierający i zamykający <...> tworzące znacznik HTML muszą się znaleźć w tej samej linii. W przeciwnym przypadku znacznik nie będzie działał. Ta właściwość umożliwia bezpośrednie wpisywanie niesparowanych znaków < i > zamiast stosowania ich oznaczenia HTML w postaci <.
  • Plik utworzony w edytorze HTML należy zachować przy wyłączonej opcji wstawiania znaków końca przy zawijaniu tekstu. W przypadku problemów pojawiających się przy bezpośrednim kopiowaniu i wklejaniu tego pliku na stronę TWiki, należy sprawdzić ten plik w zwykłym edytorze tekstowym z wyłączoną opcją zawijania linii.

Skróty

Charakterystyczną cechą TWiki jest możliwość tworzenia skrótów bez konieczności wstawiania dodatkowych instrukcji formatujących. Wystarczy zastosować tzw. nazwy WikiWordPl. Nowe zasady tworzenia skrótów w TWiki z wykorzystaniem podwójnych nawiasów kwadratowych są prostym rozszerzeniem tej możliwości.

Skróty do stron TWiki

• GoodStyle jest nazwą WikiWordPl która jest interpretowana jako skrót do strony GoodStyle umieszczonej w bieżącym dziale Indymedia Documentation Project.
• JeszczeNieMa^? jest skrótem do jeszcze nie istniejącej strony. Wystarczy kliknąć na znak zapytania ?, aby utworzyć tę stronę i rozpocząć jej edycję. Proszę spróbować, lecz proszę jej nie zachowywać, gdyż zniszczyłoby to powyższy przykład!

Skróty do innych stron WWW

• Napisy w rodzaju http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... i mailto:...@... powodują automatyczne utworzenie odpowiednich skrótów.

• Dotyczy to również napisów w postaci adresów email, np. napis nazwa@domena.com zostanie rozwinięty do odpowiedniego skrótu.

• [[Nawiasy kwadratowe]] umożliwiają łatwe tworzenie skrótów bez stosowania nazw TWiki.WikiWordPl.
  • Można również napisać [[http://yahoo.com Strona domowa Yahoo]], co ułatwia tworzenie skrótów z tekstem opisu, np. Strona domowa Yahoo.

Zmienne TWiki

Zmienne to nazwy objęte znakami procent %. Są one rozwijane na bieżąco. Poniżej podano przykłady użytecznych zmiennych i ich rozwinięcia.

• %TOC% : Spis treści tworzony w oparciu o teksty nagłówków umieszczonych na stronie. Działanie zmiennej można zaobserwować na górze bieżącej strony.

• %WEB% : Nazwa bieżącego działu. W tym przypadku jest to TWiki.

• %TOPIC% : Nazwa bieżącej strony. W tym przypadku jest to TextFormattingRulesPl.

• %ATTACHURL% : Adres URL załącznika do bieżącej strony. Wpisanie instrukcji %ATTACHURL%/image.gif spowoduje wyświetlenie graficznego pliku załącznika.

• %INCLUDE{"PewnaStrona"}% : Zawartość strony "PewnaStrona". Wpisanie takiej instrukcji spowoduje wstawienie do bieżącej strony zawartości strony "PewnaStrona". Przykład: %INCLUDE{"TWiki.SiteMap"}%

• %SEARCH{"sushi"}% : Wyniki wyszukiwania podanego tekstu ("sushi"). Strona FormattedSearch umożliwia formatowanie wyników wyszukiwania i może być zastosowana wewnątrz tworzonych aplikacji.

• Na stronie TWikiPreferences zdefiniowano szereg zmiennych globalnych. Są to m.in.:
  • Koniec linii: Można napisać %BR% aby wymusić złamanie linii.
  • Tekst w kolorze: Można napisać : kolory %RED% czerwony %ENDCOLOR% i %BLUE% niebieski %ENDCOLOR% aby uzyskać: kolory czerwony i niebieski .
  • Ikony używane w dokumentacji TWiki: Można napisać: %H% Pomoc, %T% Podpowiedź, %X% Uwaga aby uzyskać: Pomoc, Podpowiedź, Uwaga. Więcej informacji na stronie TWikiDocGraphics.

• Jest znacznie więcej zmiennych. Zobacz na stronie TWikiVariables.

Wtyczki rozszerzające możliwości formatowania tekstu

Wtyczki rozszerzają możliwości formatowania tekstu i funkcjonalność Indymedia Documentation Project. Przykładowo wtyczka SpreadSheetPlugin umożliwia utworzenie arkusza kalkulacyjnego za pomocą instrukcji formatujących podobnych do tych stosowanych przy tworzeniu tabel.

Dostępne wtyczki znajdują się na stronie Plugins w TWiki.org. Zmienna %PLUGINDESCRIPTIONS% zawiera listę wtyczek dostępnych w bieżącej instalacji TWiki:

• DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
• SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Indymedia Documentation Project topics.
• CommentPlugin: Allows users to quickly post comments to a page without an edit/preview/save cycle.
• EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
• SmiliesPlugin: Render smilies as icons, like  :-) for or  :cool: for
• TablePlugin: Control attributes of tables and sorting of table columns

Ustawienia wtyczek dla bieżącej instalacji TWiki można sprawdzić na stronie TWikiPreferences.

Typowe błędy

Zasady formatowania tekstu w TWiki są proste i można się ich szybko nauczyć. Należy jednak zwrócić uwagę na kilka szczegółów (zobacz TextFormattingFAQ):

• Pytanie: Co zrobić, aby tekst umieszczony w nawiasach trójkątnych, np. <nazwapliku> został poprawnie wyświetlony. ?
  • Odpowiedź: Znaki mniejszości '<' i większości '>' mają znaczenie specjalne w HTML, gdyż służą do definiowania znaczników. Należy je zacytować, tzn. napisać '<' zamiast '<' i '>' zamiast '>'.
    Przykład: aby otrzymać 'prog <filename>', należy napisać 'prog <filename>'.

• Pytanie: Dlaczego czasami znak ampersand '&' nie jest wyświetlany?
  • A: Znak ampersand '&' ma znaczenie specjalne w HTML, gdyż rozpoczyna tzw. jednostkę znakową, np. napis '©' jest interpretowany jako znak praw autorskich ©. Aby wyświetlić znak ampersand '&' należy go zacytować, tzn. napisać '&' zamiast '&'.
    Przykład: aby otrzymać 'To & owo', należy napisać 'To & owo'.