Markdown, MultiMarkdown i CriticMarkup

Markdown (MD), MultiMarkdown (MMD) i CriticMarkup (CM) to systemy znaczników, które pozwalają na oddzielenie treści i struktury tekstu od informacji o jego formatowaniu (wyglądzie). Najpierw piszemy tekst, a o tym, jak ma wyglądać, decydujemy później. Są to systemy bardzo proste, uniwersalne i niezwykle wygodne w użyciu.

Do pracy przy użyciu systemów MD, MMD czy CM wystarczy dowolny edytor tekstu. Na przykład: TextEdit w OSX (po przełączeniu w tryb edytora), Notepad w Windows czy gedit w GNOME. Należy je odróżnić od takich programów jak Microsoft Word, Apple Pages czy OpenOffice Writer, które są procesorami tekstów i które z definicji narzucają konieczność formatowania podczas pisania.

Markdown

Markdown to system znaczników, wprowadzanych bezpośrednio do tekstu, opracowany przez przez Johna Grubera.

Strona systemu Markdown: http://daringfireball.net/projects/markdown/.

Struktura tekstu

  • Nagłówki w kolejnych stopniach wprowadza się odpowiednią liczbą oktotorpów (#) przed i po treści nagłówka.
  • Nagłówki w dwóch pierwszych stopniach można wprowadzić także znakami równości (=) i minusa (-) w wierszu następnym po treści nagłówka.
  • Akapity oddziela się od siebie pustym wierszem.
  • Wymuszenie przejścia do nowego wiersza wprowadza się dwiema spacjami (  ) przed znakiem końca akapitu.
Struktura
Struktura

Wyróżnienia

  • Pochylenie wprowadza się znakiem gwiazdki (*) lub znakiem podkreślenia (_) z obu stron wyróżnionego tekstu.
  • Pogrubienie wprowadza się dwoma znakami gwiazdki (**) lub dwoma znakami podkreślenia (__) z obu stron wyróżnionego tekstu.
  • Pogrubione pochylenie wprowadza się trzema znakami gwiazdki (***) lub trzema znakami podkreślenia (___) z obu stron wyróżnionego tekstu.
Wyróżnienia
Wyróżnienia

Elementy tekstu

  • Wyliczenia z punktami tworzy się znakiem gwiazdki (*), plusa (+) lub minusa (-) na początku wiersza, wyliczenia z punktami numerowanymi tworzy się wpisując liczbę ze znakiem kropki (*.). Jeśli chcemy wyrównać wyliczenie z punktami numerowanymi (na przykład z liczbami wielocyfrowymi), pomiędzy liczbę a treść punktu należy wstawić tabulator.
Wyliczenia
Wyliczenia
  • Przytoczenia (cytaty) w tekście tworzy się wstawiając znak ostrokątnego nawiasu zamykającego (>) na początku akapitu z przytoczeniem.
Przytoczenia
Przytoczenia
  • Łącza to odwołania do witryn internetowych. Nazwę łącza podaje się w nawiasach kwadratowych ([ ]), adres łącza w nawiasach okrągłych (( )), tytuł łącza można podać w cudzysłowach (" ").
Łącza
Łącza
  • Aby w szybki sposób oznaczyć łącze internetowe albo adres e-mail w tekście, należy je otoczyć nawiasami ostrokątnymi (< >). Przy eksporcie zostaną one prawidłowo wygenerowane, a adres e-mailowy zostanie zamieniony na encje (po umieszczeniu w Internecie oszuka to automaty spamujące).
Łącza automatyczne
Łącza automatyczne
  • Aby wstawić ilustrację w tekście należy użyć kolejno wykrzyknika (!), następnie w nawiasach kwadratowych ([ ]) alternatywnej nazwy dla ilustracji (parametr alt), następnie w nawiasach okrągłych (( )) łącza do ilustracji, na końcu ewentualnie w cudzysłowach (" ") można podać tytuł ilustracji (parametr title).
Ilustracje
Ilustracje

MultiMarkdown

MultiMarkdown to rozszerzenie systemu Markdown, stworzone przez Fletchera T. Penneya. Dodaje kilka znaczników dla nowych funkcji.

Strona MultiMarkdown: http://fletcherpenney.net/multimarkdown/, opis składni: https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide.

Metadane

  • Informacje o dokumencie podaje się na początku tekstu, wpisując nazwę elementu, dwukropek, tabulator i opis elementu.
  • Niektóre dopuszczalne elementy: Title (tytuł), Subtitle (podtytuł), Author (autor), Date (data), Email (adres e-mail autora), Keywords (słowa kluczowe dla dokumentu), Revision (wersja dokumentu).
Metadane
Metadane

Automatyczne odsyłacze

  • Odsyłacze to tytuły nagłówków w nawiasach kwadratowych.
  • Odsyłacz może być dowolnym tekstem, wtedy trzeba ten tekst powtórzyć w nawiasach kwadratowych w nagłówku.
  • Odsyłacze mogą być tworzone także dla ilustracji i tabel.
Odsyłacze
Odsyłacze

Przypisy

  • Odnośnik do przypisu to dowolny tekst w nawiasach kwadratowych poprzedzony znakiem karety (^).
  • Treść przypisu powinna zostać poprzedzona powtórzonym tagiem odnośnika z dodanym dwukropkiem (:).
  • W przypadku przypisów wieloakapitowych, na początku każdego kolejnego akapitu należy wprowadzić znak tabulatora.
Przypisy
Przypisy

Tabele

  • Rubryki pionowe (kolumny tabeli) konstruuje się przy użyciu znaków cezury (|).
  • Jedno pole rubrykowe (komórka tabeli) może zajmować kilka rubryk pionowych, wtedy trzeba wstawić dodatkowo tyle cezur, ile rubryk pionowych pole rubrykowe ma dodatkowo zajmować.
  • Jedna rubryka pozioma (wiersz tabeli) może zajmować tylko jeden wiersz (w pionie).
  • Wyrównanie w rubrykach pionowych ustala się dwukropkami (:) w wierszu pod główką tabeli. Dwukropek z lewej to wyrównanie w lewo, dwukropek z prawej to wyrównanie w prawo, dwukropki z obu stron to wyśrodkowanie.
  • Tytył tabeli można wstawić nad lub pod tabelą w nawiasach kwadratowych
Tabele
Tabele

Bibliografia

  • Odsyłacz bibliograficzny składa się z dwóch części w nawiasach kwadratowych: z numeru/numerów stron i oznaczenia dzieła poprzedzonego oktotorpem (#).
  • Opis bibliograficzny składa się z powtórzonego oznaczenia dzieła, dwukropka i informacji o dziele.
  • Element numeru strony/stron nie jest obowiązkowy, może być pusty, wtedy zamienia się go miejscami z oznaczeniem dzieła.
Bibliografia
Bibliografia

CriticMarkup

System znaczników CriticMarkup pozwala na śledzenie zmian w tekście. Został wymyślony przez Gabe’a Weatherheada we współpracy z Erikiem Hessem.

Strona CriticMarkup: http://criticmarkup.com.

  • W CriticMarkup dostępnych jest pięć znaczników: dodawanie {++ ++}, kasowanie {–– ––}, zastępowanie {~~ ~> ~~}, komentowanie {>> <<} i oznaczanie {== ==}{>> <<}.
  • CM nie wspiera w tej chwili przypisania autorstwa poszczególnym edycjom w tekście. Jeśli jest to konieczne, autorstwo można oznaczyć w tagu komentarza, poprzedzając je znakiem @.
CriticMarkup
CriticMarkup