wiki:MarkupSyntax

Version 5 (modified by dozzie, 8 years ago) (diff)

--

Składnia języka formatowania

formatowanie w wierszu

Znak \ usuwa specjalne znaczenie dowolnego znaku, jaki po nim następuje. Żeby otrzymać literalnie \, trzeba go podwoić. Znaki, które nie są traktowane specjalnie, a zostały poprzedzone backslashem, pozostają bez zmian (choć backslash jest usunięty).

font

  • pogrubienie: **pogrubienie**
  • kursywa: __kursywa__
  • przekreślenie: ~~przekreślenie~~
  • font maszynowy: {{font maszynowy}}

linki

  • link wewnątrz aplikacji: [[InnaStronaWiki]]
    • link z opisem: [[InnaStronaWiki inna strona wiki]]
  • link do zasobu na zewnątrz: [[http://www.example.net/]]
    • link z opisem: [[http://www.example.net/ link do example.net]]

makra

  • wywołanie makra: @list_of_servers()
    • ponowne wstawienie wartości makra: $list_of_servers
  • wywołanie makra z parametrem:
    • @server_status("onyx.example.net")
    • @free_disk_space($list_of_servers, "/")

formatowanie blokowe

Podobnie jak przy formatowaniu w wierszu, \ usuwa specjalne znaczenie dowolnego znaku.

komentarze

# Komentarze zaczynają się od znaku "#".
# Komentarze nie są wyświetlane w żaden sposób.
# Linia komentarza nie zawiera nic oprócz treści komentarza.

nagłówki

= nagłówek poziomu 1 =

== nagłówek poziomu 2 ==

=== nagłówek poziomu 3 ===

==== nagłówek poziomu 4 ====

===== nagłówek poziomu 5 =====

podział akapitu i wiersza

Akapity są oddzielone pustą linią.

Akapit pierwszy.

Akapit drugi.

Wiersze w obrębie akapitu są oddzielone linią z samotną kropką (poziom wcięcia ten sam, który obowiązuje dla akapitu).

Pierwszy wiersz.
.
Drugi wiersz.

Drugi akapit.

Kropkę da się, rzecz jasna, wycytować znakiem \.

kod (<pre>)

Preformatowany fragment tekstu (na przykład wycinek kodu źródłowego) powinien być samodzielnym akapitem wciętym o 4 spacje.

Jakiś akapit.

    kawałek kodu
    dalsza część kodu
      kod wcięty o 2 spacje
    powrót

Dalszy akapit.

tabele

Proste tabele formatuje się semigraficznie.

# komórki nagłówkowe (<th>)
||* nazwa serwera *||* RAM (MB) *||* architektura *||
# komórki zwykłe (<td>)
||  onyx           ||  1024      ||  x86_64        ||
# nie trzeba trzymać równych odstępów
|| sandstone || 256 || i386 ||
# w wierszu mogą występować <th> i <td>
|| cfmaster || 256 ||* ARM *||

Przykład z makrem:

||* nazwa serwera *||* RAM (MB)     *||* architektura  *||
|| @servers()      || @ram($servers) || @arch($servers) ||

listy

Wypunktowanie to samodzielny akapit. Elementy zaczynają się od znaku * wciętego o dwie spacje w stosunku do bieżącego poziomu wcięć. Po złamaniu wiersza w źródle kontynuacja jest wcięta o dalsze dwie spacje (wyrównana do początku tekstu).

Wypunktowanie wewnątrz listy nie musi (i nie może) zaczynać akapitu pustą linią.

Numerowanie jest podobne do wypunktowania. Elementy zaczynają się od (wciętej) liczby z kropką ("[0-9]+\.") albo litery z kropką ("[a-z]\."), co wskazuje na rodzaj numerowania. Liczby i litery mogą mieć dowolną kolejność; rzeczywiste wartości zostaną dobrane automatycznie.

Akapit.

  1. pierwszy punkt
  1. drugi punkt
    a. drugi a)
    a. drugi b)
      * wypunktowanie
      * kolejne wypunktowanie, tym razem o dłuższym tekście,
        przez co trzeba było złamać wiersz
        .
        a tak wygląda wymuszenie nowej linii
    a. drugi c)
  1. trzeci punkt

Dalszy akapit.

pod-bloki

Może się okazać, że komórka tabeli musi zawierać więcej niż tylko prostą linijkę tekstu. Może to być inna tabela (wewnętrzna), numerowanie, wypunktowanie, akapit albo dowolna ich kombinacja.

Pod-blok jest traktowany jak cały akapit.

||* serwer   *||* wolne miejsce                *||
|| @servers() || %free_disk_on_server($servers) ||

____
# to powyżej to cztery podkreślniki

%free_disk_on_server($server) {{{
||* mountpoint     *||* miejsce                   *||
|| @mounts($server) || @free_disk($server,$mounts) ||
# kropka przed zamknięciem użyta tylko ze względu na formatowanie w Tracu
.}}}

TODO

  • pragmas
    • spis treści (TOC)
    • definicje kolorów dla stanów zwróconych przez makra
    • inne?
  • <div> i <span> z klasami CSS
    • może ^css_class{...} i !css_class{...}?