Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

Transkrypt

1 Menadżer projektów L A T E X w e-science.pl Podręcznik użytkownika

2 Tytuł: Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika. Podręcznik jest udostępniany na licencji Creative Commons: niekomercyjne-na tych samych warunkach 3.0 Polska, Wrocław Uznanie autorstwa-użycie Oznacza to, że wszystkie zawarte nim treści można kopiować i wykorzystywać do celów niekomercyjnych, a także tworzyć na ich podstawie utwory zależne pod warunkiem podania autora i nazwy licencjonodawcy oraz udzielania na utwory zależne takiej samej licencji. Tekst licencji jest dostępny pod adresem: Licencjonodawca: Politechnika Wrocławska Wrocławskie Centrum Sieciowo-Superkomputerowe Wybrzeże Wyspiańskiego Wrocław siedziba: pl. Grunwaldzki 9, bud. D-2 tel , fax kdm@wcss.pl; www: Podręcznik powstał podczas realizacji projektu Specjalizowana Polska Infrastruktura Naukowa na rzecz Laboratoriów Badawczych przez Wrocławskie Centrum Sieciowo-Superkomputerowe w okresie od do r. Projekt finansowany był ze środków Europejskiego Funduszu Rozwoju Regionalnego w ramach Programu Operacyjnego Innowacyjna Gospodarka oraz budżetu Państwa (nr POIG /13).

3 Spis treści 1 Instrukcja Dostęp do usługi Wyświetlanie listy projektów Tworzenie nowego projektu Edycja dokumentu Tryb pełnoekranowy Wyszukiwanie i zastępowanie tekstu w dokumencie Zwijanie bloku tekstu System uzupełniania komend Śledzenie zmian Czat Ustawienia dodatkowe Pobieranie projektu oraz plików Udostępnianie dokumentu Zarządzanie projektami Wylogowanie Dokumentacja L A T E X-a

4 Rozdział 1 Instrukcja Menadżer projektów L A T E X jest usługą Platformy e-science.pl służącą do zarządzania dokumentacją tworzoną w środowisku L A T E X. Do korzystania z tej usługi potrzebna jest przeglądarka internetowa z włączoną obsługą JavaScript. Do zarządzania projektami tworzonymi za pomocą Menadżera projektów L A T E X konieczne jest posiadanie konta na Platformie e-science.pl. Ponadto, usługa pozwala na współdzielenie dokumentów z osobomi nie posiadającym konta na e-science.pl. 1.1 Dostęp do usługi Usługa Menadżer projektów L A T E X wraz z zestawem innych usług Platformy została udostępniona pod adresem Po zalogowaniu do Platformy w panelu bocznym wyświetlana jest lista dostępnych usług (rys. 1.1). W celu rozpoczęcia pracy z usługą Menadżer projektów L A T E X należy rozwinąć zakładkę E- DOCS, a następnie kliknąć na Menadżer projektów L A T E X. Rys. 1.1: Panel aplikacji udostępnionej pod adresem widoczny po zalogowaniu

5 1.2 Wyświetlanie listy projektów 1.2 Wyświetlanie listy projektów Po zalogowaniu wyświetlona zostanie tabela zawierająca listę utworzonych projektów (rys. 1.2). Dla każdego z projektów prezentowane są informacje o nazwie dokumentu, folderze w którym się on znajduje oraz właścicielu. Rys. 1.2: Panel z listą utworzonych projektów oraz przyciskami umożliwiającymi dodanie lub import nowego projektu 1.3 Tworzenie nowego projektu Aby stworzyć nowy projekt, należy kliknąć na Dodaj nowy projekt. Wyświetlony zostanie wówczas panel wyboru typu dokumentu (rys. 1.3). Należy wybrać Dokument L A T E X, podać nazwę projektu (pole Nazwa), a następnie kliknąć na przycisk Zapisz. We wpisywanej nazwie należy unikać znaków specjalnych i polskich liter. Rys. 1.3: Tworzenie nowego projektu Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 5

6 1 Instrukcja 1.4 Edycja dokumentu Po utworzeniu nowego lub wybraniu istniejącego projektu wyświetlone zostaje okno edycji, w którym dostępne są trzy panele oraz górne menu (rys. 1.4). Rys. 1.4: Panel edycji i podglądu projektu W lewym górnym panelu znajduje się przyciski umożliwiające: Utorzenie nowego pliku Utworzenie nowego folderu Wysłanie pliku z lokalnego komputera na serwer Zmianę nazwy pliku lub folderu Usunięcie projektu Po kliknięciu w nazwę pliku, znajdującego się w lewym panelu okna edycji, w środkowym panelu wyświetlona zostaje jego zawartość (przeważnie do edycji wykorzystywany jest plik main.tex). Plik ten można edytować, używając odpowiednich komend L A T E X-a. Elementy kodu L A T E X-owego są wyświetlane na niebiesko, więc łatwo odróżnić komendy od tekstu. Po napisaniu tekstu należy kliknąć przycisk Recompile w prawym panelu (rys. 1.5). Zostanie wygenerowany podgląd pdf-a lub lista komunikatów o błędach. Obok przycisku Recompile znajduje się przycisk Logs and output files - po jego wybraniu można szczegółowo przeanalizować błędy, które pojawiły się w czasie kompilacji dokumentu i pobrać pliki:.aux,.bbl,.bgl,.log,.synctex.gz. Pliki te nie są pobierane podczas ściągania projektu na dysk lokalny. 6 Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

7 1.5 Tryb pełnoekranowy Rys. 1.5: Generowanie pliku pdf i przeglądanie komunikatów diagnostycznych kompilacji Przycisk Download PDF służy do otwierania dokumentu pdf w nowym oknie przeglądarki. Ostatnia ikona (kwadrat) Full screen umożliwia pracę w trybie pełnoekranowym - panele edycji i podglądu nakładają się na siebie. Po umieszczeniu kursora myszy w lewym górnym rogu podglądu wygenerowanego pdf-a pojawiają się dodatkowe przyciski pozwalające na: dopasowanie szerokości i wysokości dokumentu oraz powiększenie lub pomniejszenie widoku (rys. 1.6). Rys. 1.6: Przyciski umożliwiające skalowanie widoku dokumentu 1.5 Tryb pełnoekranowy Aby wyświetlić kod projektu lub wygenerowany plik pdf w trybie pełnoekranowym należy kliknąć w ikonę (kwadrat) znajdującą się w prawym górnym rogu panelu podglądu pdf (rys. 1.7). Powrót do standardowego widoku jest możliwy po kliknięciu w ikonę (dwa prostokąty) znajdująca się w w prawym górnym rogu panelu(rys. 1.8).Przełączenie między pełnoekranowym podglądem pdf i kodu następuje po kliknięciu w pozycję PDF w lewym panelu (rys ). Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 7

8 1 Instrukcja Rys. 1.7: Przejście do trybu pełnoekranowego Rys. 1.8: Tryb pełnoekranowy podgląd PDF Rys. 1.9: Tryb pełnoekranowy podgląd kodu 1.6 Wyszukiwanie i zastępowanie tekstu w dokumencie Podczas edycji tekstu można wykonać podstawowe czynności kopiuj-wklej (Ctrl+C, Ctrl+V) oraz włączyć moduł wyszukiwanie Ctrl+F w nowym oknie, które się pojawi należy wpisać wyszukiwane ciągi znaków (rys. 1.10). 1.7 Zwijanie bloku tekstu Podczas edycji dokument można dzielić na mniejsze części lub zastosować przydatną funkcje zwijania całych bloków kodu. W tym celu należy skorzystać z małej strzałki znaj- 8 Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

9 1.8 System uzupełniania komend Rys. 1.10: Okno pozwalające na wyszukiwanie tekstu dującej się po lewej stronie tekstu, obok numeru linii kodu. Blok tekstu zostanie zwinięty i oznaczony dwiema strzałkami na niebieskim tle (rys. 1.11). Rys. 1.11: Zwijanie bloku tekstu 1.8 System uzupełniania komend Podczas pisania kodu L A T E X można korzystać z systemu podpowiedzi. Po wpisaniu znaku \ i pierwszych liter polecenia, rozwija się lista z podpowiedziami komend. Wystarczy wtedy kliknąć lub wybrać klawiszami strzałek polecenie i zaakceptować wstawienie danej komendy (rys. 1.12). Rys. 1.12: Uzupełnianie i wybór z listy komend L A T E X-a 1.9 Śledzenie zmian Aby skorzystać z opcji śledzenia zmian w głównym menu edycji należy wybrać drugą ikonę od prawej strony, tj.ostatnie zmiany (rys. 1.13). Zostaną wyświetlone zmiany Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 9

10 1 Instrukcja wprowadzone do dokumentu, a także informacja o czasie pracy nad dokumentem. W oknie tym można również cofnąć zmiany wprowadzone do dokumentu Czat Rys. 1.13: Śledzenie zmian w projekcie Po wybraniu w górnym pasku menu pierwszej ikony z prawej strony, tj. Czat, włączy się okno dialogowe, w którym można wymieniać się informacjami z innymi osobami edytującymi dokument (rys. 1.14). Rozmowy prowadzone w oknie Czatu są zapisywane na stałe przy tworzonym projekcie. Zapis czatu jest dostępny dla wszystkich osób mający prawa do projektu. Rys. 1.14: Widok okna rozmowy 1.11 Ustawienia dodatkowe Główne menu edycji projektu znajduje się na pasku w górnej części okna i zawiera szereg ikon (rys. 1.15). Rys. 1.15: Widok głównego menu projektu 10 Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

11 1.11 Ustawienia dodatkowe Ikony oznaczają: Menu Wróć do listy projektów Nazwa projektu Ostatnie zmiany Czat Klikając ikonę Menu można ustawiać format, sposób kompilowania, plik domyślny, etc. (rys. 1.16). Rys. 1.16: Ustawienia dokumentu w zakładce Menu Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 11

12 1 Instrukcja 1.12 Pobieranie projektu oraz plików Aby pobrać projekt w Menu projektu przejść do zakładki Download (rys. 1.16). Po kliknięciu przycisku Source możliwe jest pobranie projektu spakowanego w postaci archiwum.zip i składającego się jedynie z plików źródłowych archiwum nie zawiera pliku pdf. Wybranie przycisku PDF umożliwia pobranie pliku pdf. Plik pdf można również pobrać klikając na przycisk Download PDF, znajdujący się obok przycisku Recompile (rys. 1.17). Rys. 1.17: Pobieranie pliku pdf Należy pamiętać, że pobierany pdf zawiera treść i formę ostatnio skompilowanej wersji projektu. Jeżeli wprowadzone zostały zmiany, należy wykonać kompilację, a następnie pobrać plik pdf i pliki źródłowe Udostępnianie dokumentu Aby udostępnić dokument L A T E X należy przejść do głównego ekranu usługi Menadżer projektów L A T E X. W tym celu, w głównym menu edycji dokumentu należy wybrać drugą ikonę z lewej strony, tj. Back to projects wówczas wyświetlony zostanie pierwszy ekran usługi Menadżer projetów L A T E X wraz z listą dostępnych projektów (rys. 1.2). Projekt można udostępnić na dwa sposoby. Pierwszy sposób to udostępnienie projektu osobom posiadającym konto na Platformie e-science.pl. W tym przypadku, w ostatniej kolumnie wiersza zawierającego nazwę projektu, który chcemy udostępnić, należy wybrać ikonę Udostępnij ( ). Pojawi się wówczas okno umożliwiające nadawanie uprawnień dla użytkowników i grup (rys. 1.18) projekt można udostępnić wybranym osobom należącym do tego samego zespołu na Platformie (podając imię i nazwisko w oknie Użytkownicy ) lub wszystkim osobom z tego samego zespołu (podając nazwę grupy w oknie Grupy). Drugi sposób umożliwia udostępnienie projektu osobom nie posiadającym konta na Platformie e-science.pl. Jest to możliwe poprzez wysłanie adresu www projektu na adres wybranej osoby wraz z zaproszeniem do edycji dokumentu. Aby wygenerować link, w ostatniej kolumnie wiersza zawierającego nazwę projektu, który chcemy udostępnić, należy wybrać ikonę Stwórz link publiczny ( ). W oknie, które się pojawi (rys. 1.19) należy podać e osób, do których ma zostać wysłany link oraz wybrać termin, do którego link do projektu będzie aktywny. Niebezpieczeństwo tego rozwiązania polega na tym, że każda osoba znająca adres www projektu, może przejąć dostęp do dokumentu (brak autoryzacji). We wszystkich wyżej wymienionych przypadkach można przyznawać prawo do edycji lub tylko do podglądu projektu. 12 Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

13 1.13 Udostępnianie dokumentu Rys. 1.18: Nadawanie uprawnień dla użytkowników i grup Rys. 1.19: Tworzenie publicznego adresu www projektu Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 13

14 1 Instrukcja 1.14 Zarządzanie projektami Po przejściu do usługi Menadżer projektów L A T E X wyświetlana jest lista projektów dostępnych dla użytkownika. Po prawej stronie każdej pozycji dostępne są przyciski oznaczające: Udostępnij udostępnienie dokumentu osobom zarejestrowanym w e-science.pl Stwórz link publiczny udostępnienie dokumentu osobom niezarejestrowanym w e-science.pl Pokaż uprawnienia wyświetlanie informacji o uprawnieniach przyznanych członkom zespołu i zarządzanie nadanymi uprawnieniami Pokaż linki publiczne wyświetlenie informacji o utworzonych linkach publicznych i zarządzanie nadanymi uprawnieniami Zmień folder zmiana folderu, w którym znajduje się projekt Skasuj usunięcie projektu W kolorze niebieskim wyświetlane są przyciski oznaczające akcje, możliwe do podjęcia przez użytkownika w przypadku danego projektu. W menu znajdującym się nad listą projektów znajduje się zakładka Filters. Po jej rozwinięciu możliwe jest wyszukanie projektu na podstawie nazwy, właściciela lub folderu, w którym jest zlokalizowany (rys. 1.20). W głównym panelu usługi Menadżer projektów L A T E X możliwe jest zakładanie nowych projektów (przycisk Dodaj nowy dokument), import projektów (przycisk Importuj dokument) oraz zarządzanie folderami dokumentów (przyciskzarządzaj folderami). Rys. 1.20: Wyszukiwanie projektu 14 Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika

15 1.15 Wylogowanie 1.15 Wylogowanie Aby wylogować się z aplikacji należy przejść do głównego ekranu usługi Menadżer projektów L A T E X. W tym celu, w głównym menu edycji dokumentu należy wybrać drugą ikonę z lewej strony, tj. Back to projects. Po przejściu do głównego ekranu usługi należy wybrać ikonę, która znajduje się w prawym górnym rogu ekranu (rys. 1.21). Rys. 1.21: Wylogowywanie z usługi - ikona Log out zaznaczona jest w czerwonej ramce 1.16 Dokumentacja L A T E X-a Rekomendowana dokumentacja dotycząca L A T E X-a dostępna jest m.in. na stronach: Dokumentacja w języku polskim: Łagodne wprowadzenie do T E X-a Podręcznik Michael Doob Nie za krótkie wprowadzenie do systemu L A T E X2ɛ epsilon Albo L A T E X2ɛ w 88 minut Tobias Oetiker Hubert Partl, Irene Hyna i Elisabeth Schleg Wprowadzenie do systemu L A T E X, Karol Selwat L A T E Xna kolorowo, Włodzimierz Macewicz Tworzenie dokumentów pdf przy pomocy L A T E X-a, Grzegorz Sapijaszko Jak napisać prace magisterską w L A T E Xu?, Monika Piekarz Menadżer projektów L A T E X w e-science.pl. Podręcznik użytkownika 15

16