Klub autora LaTeX i Overleaf. Część 2: Overleaf

Amber Editing > Praca nad artykułem  > Klub autora LaTeX i Overleaf. Część 2: Overleaf

Klub autora LaTeX i Overleaf. Część 2: Overleaf


Zdecydowana większość naukowców pisze artykuły w środowisku Word. Nie jest to jednak jedyne dostępne narzędzie. Nie brakuje osób, które decydują się na alternatywne rozwiązania takie jak: LaTeX (1), Scrivener (2), Open Office (3), Google Documents (4) czy DropBox Paper (5). Ten wpis jest drugim z serii. Jego celem jest przybliżenie naszym czytelnikom środowiska LaTeX obsługiwanego na platformie Overleaf (6). Aby pokazać je w praktyce wpis jest dostępny w dwóch wersjach:

  • Klasycznej– dostępnej na naszym blogu autora (7),
  • LaTeX– napisanej w środowisku LaTeX na platformie Overleaf (6).



1         Co to jest Overleaf?

W poprzedniej części cyklu opisałem ogólne różnice między pisaniem artykułu w środowisku LaTeX, a powszechnie używanymi narzędziami WYSIWYG takich jak Word (8). Dzisiaj przedstawię krótkie wprowadzenie w środowisko Overleaf, które jest najlepszym sposobem na zaczęcie swojej przygody z LaTeX-em. Dla doświadczonych użytkowników LaTeX-a daje on dostęp do nowych funkcji.

1.1          Pierwszy kontakt

Aby rozpocząć pisanie artykułu należy wejść na stronę Overleaf (6) i zarejestrować się. Następnie po zalogowaniu należy wybrać opcję ”New Project”. Po rozpoczęciu projektu zaczniemy pracę w oknie przedstawionym na rysunku 1. Edycja artykułu wymaga znajomości podstawowych komend i poleceń w LaTeX. Ich nauka nie jest trudna, poświęcimy jej osobny wpis.

Jednym z wyzwań dla osób rozpoczynających pracę z LaTeX jest rozdzielenie procesu pisania z warstwą wizualną artykułu. Najpierw należy wprowadzić kod źródłowy, który dopiero po skompilowaniu przyjmuje postać gotowego, eleganckiego artykułu w formacie pdf. Kilka lat temu wymagało to nieustannego skakania między oknami. Nowoczesne edytory umożliwiają podgląd pliku pdf na bieżąco. Tak działa też Overleaf co widać na rysunku 1.


Rysunek 1: Pisanie artykułu w środowisku Overleaf. Lewe okno służy do wprowadzania tekstu źródłowego, prawe przedstawia plik wynikowy pdf. Lewa kolumna zawiera listę plików zawartych w projekcie. Górny pasek zawiera przyciski związane z edycją artykułu.

1.2          Praca z tekstem

Komendy wprowadzamy w lewym okienku. Rezultat wprowadzonych zmian jest widoczny w pliku pdf przedstawionym po prawej stronie. Aby odświeżyć widok należy wcisnąć przycisk ”Recompile”. Obok przycisku ”Recompile” znajdziemy też ikonkę z komunikatami dotyczącymi kompilacji. Są one bardzo pomocne i warto je przeglądać aby znaleźć błędy w kodzie źródłowym (przykład jest widoczny na rysunku 2). Komunikaty mogą zawierać informację o:

  • błędach w języku LaTeX;
  • brakujących plikach;
  • złej etykiety referencji (autor przywołuje etykietę referencji, która nie istnieje);
  • złej etykiety rysunku/tabeli/sekcji (autor przywołuje etykietę rysunku/tabeli/sekcji która nie istnieje);
  • duplikujących się etykietach;
  • brakujących pakietach.




Rysunek 2: Okno edycji artykułu w środowisku Overleaf. Po wciśnięciu przycisku ”Recompile” aktualizuje się widok artykułu w prawym oknie. Możliwe jest też przejrzenie komunikatów przy kompilacji artykułu.

Overleaf oferuje też wizualny edytor tekstu. Przedstawia go rysunek 3. Jest on dużo lepszym rozwiązaniem dla osób przyzwyczajonych do pisania w Word czy Open Office, ponieważ tekst wprowadza się w bardzo podobny sposób. Wiele komend LaTeX jest zastąpionych przyciskami funkcyjnymi. Aby zmienić format tekstu, umieścić referencję lub odnośnik nie trzeba wpisać odpowiedniej komendy, tylko wcisnąć przycisk w górnym pasku. Praca w tym trybie jest możliwa bez większej znajomości języka LaTeX. Konsumuje jednak więcej czasu niż wpisywanie kodu źródłowego. Dlatego osoby znające dobrze środowisko LaTeX prawdopodobnie nie będą z niego chciały korzystać.


Rysunek 3: Okno edycji artykułu w środowisku Overleaf. Po wyborze opcji ”Rich Text” lewe okno staje się bardziej przystępne dla osób nie znających dobrze języka LaTeX.

2         Najważniejsze funkcje

2.1        Etykiety

Jedną z zalet środowiska LaTeX jest możliwość korzystania z etykiet. Odbywa się ona za pomogą dwóch komend. Pierwsza z nich służy nadaniu etykiety

\label{amber}

. Użycie takiej komendy służy przypisaniu zdefiniowanej etykiety (w tym przypadku ”amber”) do danego obiektu sekcji/rysunku/tabeli/równania. Dzięki etykiecie będzie możliwe przywołanie danego obiektu w dowolnym miejscu tekstu. Dla przykładu napisanie

Równanie \ref{amber} wyraźnie pokazuje, że ...

pozwala programowi automatycznie podać numer równania, które oznaczyliśmy etykietą ”amber”.

Bardzo podobnie działa system przywoływania referencji. Lista artykułów powinna być jednak składowana w osobnym pliku ”references.bib”, który zawiera wszystkie informacje na temat artykułów oraz przypisuje im etykiety. W trakcie pisania artykułu wystarczy przywołać komendę

\cite{amber}

aby artykuł o etykiecie ”amber” został zacytowany i automatycznie umieszczony w bibliografii.

2.2         Autouzupełnianie

Overleaf oferuje bardzo pomocną funkcję auto uzupełniania komend i etykiet. Tuż po rozpoczęciu polecenia LaTeX edytor automatycznie proponuje nam listę możliwych komend do wyboru. Dzięki temu nie musimy pamiętać dokładnie wszystkich poleceń LaTeX. Wystarczy ogólne wyczucie jak działa środowisko LaTeX. Jest to szczególnie pomocne dla osób, które dorywczo piszą artykuły w tym środowisku. Pozwala też na dużo szybszą pracę nad tekstem.

2.3          Praca w grupie

Tradycyjnie jedną z największych słabości środowiska LaTeX była niełatwa praca w grupie. Edytory LaTeX nie posiadały funkcji śledzenia zmian ani możliwości współedycji. Overleaf to zmienił. W górnym pasku posiadamy serię przycisków przydatnych przy grupowej racy nad tekstem:

  • ”Review” – możliwość dodawania komentarzy do tekstu
  • ”Share” – dzielenie pliku ze współpracownikami
  • ”History” – podgląd historii zmian pliku
  • ”Chat” – możliwość przeprowadzenia dyskusji poświęconej artykułowi
  • ”Submit” – przycisk służący do wysłania tekstu bezpośrednio do czasopisma naukowego. Dotyczy on coraz większej listy czasopism współpracujących z platformą Overleaf.



Niestety wersja darmowa Overleaf nie zawiera większości z tych funkcji.

3            Podsumowanie

Jeżeli rozważasz rozpoczęcie pracy w LaTeX, to Overleaf jest świetnym narzędziem aby spróbować. Nie wymaga instalacji dodatkowych programów, a rejestracja zajmuje kilka minut. Nie polecam tego narzędzia bez powodu – sam z niego korzystam.

Widzimy wśród naszych klientów wyraźny wzrost zapotrzebowania na usługi tłumaczenia i proofreadingu realizowanych na artykułach napisanych w LaTeX. Dlatego nawiązaliśmy współpracę z twórcami Overleaf i dzięki temu wykorzystujemy to narzędzie do pracy nad Państwa tekstami.

Grzesiek

Odnośniki

[1] Strona projektu . [Online]. Available: https://www.latex-project.org/about/
[2] Strona           programu            scrivener.            [Online]. Available:        https://www. literatureandlatte.com/scrivener/overview
[3] Strona programu open office. [Online]. Available: https://www.openoffice. org/
[4] Strona platformy google documents. [Online]. Available: https://www. google.com/docs/about/
[5] Strona platformy dropbox paper. [Online]. Available: https://www.dropbox. com/paper
[6] Strona platformy overleaf. [Online]. Available: https://www.overleaf.com
[7] T. Liśkiewicz and G. Liśkiewicz. Klub autora amber editing. [Online]. Available: https://www.overleaf.com
[8] Klub autora   latex      i             overleaf,              część      1.        [Online]. Available:            https: //www.overleaf.com/read/ngrvznpbypcy