Pomijanie regionów za pomocą pragm

Przegląd

Czasami trzeba zapobiec przeformatowaniu określonych regionów przez snappera: ręcznie sformatowanej poezji, wyrównanego tekstu, starannie ułożonych tabel w prozie lub dowolnego tekstu, w którym podziały wierszy niosą znaczenie.

Użyj pragm snapper:off i snapper:on, aby oznaczyć regiony, które powinny przejść bez zmian.

Składnia według formatu

Org-mode

Some prose that gets reformatted normally.

# snapper:off
This text will not
be reformatted. Line breaks
are preserved exactly.
# snapper:on

More prose that gets reformatted.

LaTeX

Some prose that gets reformatted normally.

% snapper:off
This text will not
be reformatted.
% snapper:on

More prose that gets reformatted.

Markdown

Some prose that gets reformatted normally.

<!-- snapper:off -->
This text will not
be reformatted.
<!-- snapper:on -->

More prose that gets reformatted.

Zwykły tekst

Some prose that gets reformatted normally.

snapper:off
This text will not
be reformatted.
snapper:on

More prose that gets reformatted.

Przypadki użycia

  • Poezja lub wiersze z celowymi podziałami wierszy

  • Grafika ASCII lub diagramy w komentarzach

  • Starannie wyrównane listy odniesień

  • Nagłówki licencji ze specyficznym formatowaniem

  • Tekst, który musi dokładnie odpowiadać zewnętrznemu źródłu

Zagnieżdżanie

Pragmy nie zagnieżdżają się. snapper:off wyłącza formatowanie aż do następnego snapper:on. Jeśli plik kończy się bez snapper:on, reszta pliku przechodzi bez zmian.

Interakcja z innymi funkcjami

Pragmy mają priorytet nad wszystkimi innymi operacjami parsowania. Wewnątrz regionu wyłączonego nie następuje podział zdań, parser rozpoznający format ani obsługa skrótów. Same linie komentarzy pragm zawsze przechodzą jako struktura.