No description, website, or topics provided.
Perl TeX Ruby Shell
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Autozoil
t
.gitignore
README.markdown
autofix.rb
autozoil
autozoil.pl
extra-en.dic
extra-pl.dic
test.tex

README.markdown

autozoil

Build Status

Autozoil is a comprehensive checker for texts written in (La)Tex, mainly MSc theses and scientific papers. Autozoil has been used for Polish and English texts so far. The program was created for checking MSc theses supervised by Filip Graliński at the Faculty of Mathematics and Computer Science of Adam Mickiewicz University in 2010/2011.

Autozoil to program do kompleksowego sprawdzania tekstów pisanych w (La)TeX-u, głównie prac magisterskich i prac naukowych. Do tej pory autozoil był używany do tekstów polskich i angielskich. Program powstał przy okazji pisania prac magisterskich pod kierunkiem Filipa Gralińskiego na Wydziale Matematyki i Informatyki Uniwersytetu im. Adama Mickiewicza w roku akademickim 2010/2011.

Running / wywołanie

perl autozoil.pl --locale pl_PL tekst_po_polsku.tex

perl autozoil.pl --locale en_GB text_in_english.tex

Modules / Moduły

The following modules are available in autozoil:

Następujące moduły są dostępne w autozoilu:

Authors / Autorzy

  • Filip Graliński
  • Mirosław Zemski
  • Roman Grundkiewicz
  • Jakub Gruszecki
  • Jan Legutko
  • Kajetan Wilczek

Suppressing warnings

[Only in Polish for the time being.]

Czasami istnieje potrzeba "uciszania" błędów zgłaszanych autozoila. W związku z tym została wprowadzona możliwość "uciszania" błędów za pomocą dwóch konstrukcji:

  1. % --|SPECS

Ucisza wskazane w SPECS błędy w danym, pojedynczym wierszu.

% --<SPECS
.....
.....
.....
% -->

Ucisza wskazane w SPECS błędy w całym obszarze. (% --> zamyka "uciszany" obszar).

(W obu przypadkach między znakiem % a -- może wystąpić dowolna liczba spacji - w szczególności zero).

SPECS to lista specyfikacji oddzielonych przecinkami. Każda specyfikacja to:

  • etykieta błędu (tj. pierwsze pole w wyjściu autozoila), np. grammar-BRAK_SPACJI, spell-search czy latex-36
  • zamiast właściwej etykiety po - można dać *, co oznacza wyciszenie wszystkich błędów danego typu (np. spell-*).

Przykład konkretnego wyciszenia typu (1):

(Fragment kodów źródłowych w~języku Perl). % --|latex-36

Przykład wyciszenia typu (2):

% --<spell-*,grammar-*,latex-*
\lstset{
  escapeinside=||,
  basicstyle={\small\ttfamily},

...

\end{lstlisting}
% -->

Uwaga: jeśli zostanie napotkane uciszenie, dla którego błąd wcale nie wystąpił (zbędne uciszenie), jest to zgłaszane jako błąd! W przypadku specyfikacji z * muszą wystąpić przynajmniej 3 błędy.

Typowe problemy

Niektóre z typowych problemów (np. twarda spacja po krótkim wyrazie) jest w stanie naprawić pomocniczy skrypt autofix.rb:

 ruby autofix.rb plik.tex

(Wymagana instalacja interpretera języka Ruby). Niestety skrypt autofix.rb nie jest doskonały i należy sprawdzić wyniki jego działania.

Angielskie słowa w polskim tekście

Autozoil pomija - przy sprawdzaniu poprawności ortograficznej - słowa objęte instrukcją \english{...} i \eng{...}.

(W klasie uam-wmi-msc słowa objęte instrukcją \english{...} są składane kursywą, co jest tradycyjnym sposobem oddawania obcojęzycznych wstawek, instrukcja \eng{foo} rozwija się natomiast do "(ang.~\english{foo})").

W stosunku do nazw własnych i akronimów nie należy stosować instrukcji \english (nie powinny być składane kursywą!). Takie słowa (lub człony wielowyrazowych nazw) należy dodać do słownika wyjątków lub "wytłumić", jak opisano wyżej, jeśli ich użycie jest okazjonalne.

Z kolei rozwinięcia akronimów mogą być objęte instrukcją \english, np.:

XML (\english{eXtensible Markup Language}) to format...

Instrukcje, nazwy funkcji itp.

Instrukcje, polecenia, nazwy funkcji, krótkie fragmenty kodów źródłowych wplecionych w tekst należy objąć instrukcją \code{...}.

Numery wersji

Autozoil traktuje zapisy typu "4.5" jako błąd (w polskich typografii używamy przecinka jako separatora części dziesiętnej). W przypadku numeru wersji to oczywiście fałszywy alarm. Autozoil nie wygeneruje fałszywego alarmu, jeśli takich zapisom towarzyszy słowo "wersja" lub podobne. Należy jednak pamiętać o użyciu twardej spacji, zamiast "wersji 4.5" należy więc zapisać "wersji~4.5".

Inne przypadki fałszywych alarmów związanych z wersjami należy ręcznie wytłumić.

Arch Linux - Zależności / dependencies

  • languagetool
  • hunspell-pl
  • TAP::Harness::JUnit