Podręcznik WebIssues

Opis jest przydatny, by podać informacje o sprawie, ale czasem niezbędne są dodatkowe informacje lub pytania. W tym celu można użyć komentarzy. Aby napisać komentarz, wybierz polecenie Dodaj komentarz (upewnij się, że aktywna jest historia sprawy, jeśli korzystasz z programu Desktop Client). Nowe okno składa się niemal wyłącznie z pola edycji tekstu:

Rysunek 3.10. Dodawanie komentarza

Tekst zostanie wyświetlony dokładnie tak, jak został wpisany, z zachowaniem odstępów i podziału na linie. Umożliwia to wklejanie np. fragmentów kodu źródłowego czy logów bez obaw, że staną się one nieczytelne. Długie linie zostaną automatycznie podzielone, w zależności od szerokości okna. Adresy stron internetowych i adresy e-mail zostaną automatycznie zamienione na odnośniki. Te same zasady obowiązują w przypadku komentarzy, opisów spraw oraz opisów projektów.

Jeśli wybierzesz opcję Tekst ze znacznikami, możesz również używać specjalnych znaczników, by zmienić styl czcionki, tworzyć odnośniki, listy, itp. Zwykle ta opcja jest domyślnie wybrana, ale możesz to zmienić w swoich ustawieniach użytkownika. Wybierając opcję Zwykły tekst, możesz wyłączyć specjalne formatowanie, z wyjątkiem adresów internetowych i identyfikatorów, które nadal będą automatycznie zamieniane na odnośniki.

Pasek narzędzi ponad polem edycji tekstu automatycznie wpisze odpowiednie znaczniki za ciebie, więc nie musisz ich pamiętać. Po prostu umieść kursor w miejscu, gdzie chcesz dodać znaczniki, albo zaznacz fragment tekstu, by otoczyć go odpowiednimi znacznikami formatowania. Następujące znaczniki są rozpoznawane, jeśli zostały one włączone:

To jest **pogrubienie**.

To jest __kursywa__.

To jest `czcionka maszynowa`.

To jest [www.mimec.org odnośnik].

[list]
* pierwszy punkt
* drugi punkt
* trzeci punkt
** pierwszy podpunkt
** drugi podpunkt
[/list]

[quote Tytuł]
To jest cytat.
[/quote]

[code C++]
for ( int i = 0; i < 10; i++ )
    printf( "%d\n", i );
[/code]

for ( int i = 0; i < 10; i++ )
    printf( "%d\n", i );

[rtl]
To jest tekst od prawej do lewej.
[/rtl]

Znaczniki pogrubienia i kursywy można łączyć ze sobą i z innymi znacznikami, natomiast między znacznikami czcionki maszynowej, wszystkie inne znaczniki są ignorowane. Dzięki temu można wklejać jednoliniowe fragmenty kodu, nie psując formatowania.

Odnośniki w nawiasach kwadratowych są podobne do automatycznych odnośników, ale pozwalają na zmianę tekstu odnośnika. Jeśli tekst nie jest podany, zostanie wyświetlony adres. Możesz otaczać wszystkie adresy nawiasami kwadratowymi, by mieć pewność, że zostaną one prawidłowo rozpoznane.

Podpunkty w listach wypunktowanych mogą tworzyć maksymalnie sześć poziomów zagnieżdżenia poprzez użycie odpowiedniej liczby gwiazdek. Przed gwiazdkami może być dowolna liczba spacji, a między gwiazdkami a tekstem musi być przynajmniej jedna spacja. Punkty w liście mogą składać się z dowolnej liczby linii, mogą także zawierać cytaty i bloki kodu.

Cytaty są otoczone przerywaną ramką i mogą mieć opcjonalny tytuł. Możesz w łatwy sposób cytować istniejące komentarze lub opisy spraw używając polecenia Odpowiedz. Otworzy ono nowe okno komentarza z automatycznie załączonym oryginalnym komentarzem lub opisem wraz ze znacznikami cytatu. Cytowany tekst może zawierać inne znaczniki, w tym zagnieżdżone cytaty, listy i bloki kodu.

Bloki kodu mogą być używane do wklejania fragmentów kodu, plików logowania, itp. Są one wyświetlone dosłownie (tzn. wszystkie znaczniki są ignorowane) przy użyciu czcionki maszynowej. Jednak w odróżnieniu od znaczników czcionki maszynowej, blok kodu może zawierać wiele linii. Oprócz tego można określić język bloku kodu, co powoduje włączenie podświetlenia składni. Obsługiwane języki to: HTML, XML, C, C++, C#, Java, Bash (równoważny z SH), Python, Perl, Ruby, JavaScript (równoważny z JS), CSS, SQL, VB oraz PHP.

Bloki od prawej do lewej mogą być używane do zamieszczania fragmentów tekstu w języku zapisywanym od prawej do lewej strony, np. arabskim. Mogą one zawierać inne zagnieżdżone bloki.

Użyj przycisku Podgląd w pasku narzędzi ponad polem edycji tekstu, by zobaczyć podgląd tekstu z formatowaniem i upewnić się, że wygląda on prawidłowo.

Komentarze są wyświetlane w historii sprawy wraz z innymi zmianami w kolejności chronologicznej. Używając odnośników filtra po prawej stronie, możesz wyświetlić tylko określone informacje. Możesz zmienić domyślny filtr oraz kolejność zmian (od najstarszych lub najnowszych) w swoich ustawieniach użytkownika.

Rysunek 3.11. Historia sprawy z komentarzem

Można tworzyć odnośniki do innych spraw, a także do komentarzy lub załączników. Aby to zademonstrować, utwórzmy drugą sprawę i nadajmy jej nazwę „Druga sprawa”, pozostawiając domyślne wartości atrybutów. Załóżmy, że identyfikator pierwszej sprawy to #1, a drugiej #6.

Jeśli dodasz komentarz do pierwszej sprawy i wpiszesz w nim tekst „#6”, zostanie on zamieniony na odnośnik do drugiej sprawy. Podobnie, jeśli teraz dodasz komentarz do drugiej sprawy, wpisując tekst „#1”, stanie się on odnośnikiem do pierwszej sprawy. W ten sposób możesz tworzyć powiązania między sprawami, odnosić się do innych komentarzy w swoich komentarzach, itp. Jeśli znaczniki są włączone, identyfikatory mogą być również używane w nawiasach kwadratowych, by tworzyć odnośniki z dowolnym tekstem. Podobnie jak adresy zewnętrzne, identyfikatory są również zamieniane na odnośniki w opisach, wartościach atrybutów, itp.

Rysunek 3.12. Odnośnik do sprawy

Aby szybko przejść do sprawy, komentarza lub załącznika o podanym identyfikatorze, możesz również skorzystać z polecenia Idź do elementu. W programie Web Client kliknij Narzędzia w prawym górnym rogu okna, a następnie kliknij Idź do elementu. W programie Desktop Client polecenie to jest zawsze dostępne w pasku narzędzi głównego okna, możesz również nacisnąć Ctrl+G.

Rysunek 3.13. Przejście do elementu

Następnie wpisz szukany identyfikator i naciśnij OK. Jeśli istnieje sprawa o tym identyfikatorze, zostanie ona wyświetlona. Jeśli natomiast identyfikator reprezentuje komentarz lub załącznik, zostanie wyświetlona sprawa zawierająca ten element, a historia zostanie ustawiona na szukanym elemencie.

Polecenie Edytuj atrybuty umożliwia edycję sprawy, tzn. zmianę wartości poszczególnych atrybutów oraz nazwy sprawy. Zaznacz pierwszą sprawę i wybierz to polecenie. Zostanie wyświetlone takie samo okno, jak w przypadku dodawania nowej sprawy, zawierające aktualne wartości atrybutów.

Rysunek 3.14. Zmiana atrybutów sprawy

System WebIssues obsługuje następujące rodzaje atrybutów:

Zmień status sprawy na Rozwiązany, a w polu Powód wybierz wartość Naprawiony. Następnie naciśnij OK, aby zapisać zmiany. Zauważ, że system WebIssues automatycznie zapamiętał wprowadzone przez ciebie zmiany i wyświetla je w historii sprawy. Umożliwia to śledzenie całego cyklu życia sprawy, zmian statusu i wszystkich operacji wykonywanych na sprawie.

Rysunek 3.15. Historia sprawy po zmianie

Domyślnie w historii sprawy wyświetlone są wszystkie zmiany, komentarze i załączniki. Jeśli nie chcesz widzieć pełnej historii sprawy, a na przykład tylko komentarze, wybierz jedną z opcji filtrowania dostępnych w prawym górnym rogu widoku historii. Aby wyszukać określony tekst w treści komentarza lub innej zmiany, w programie Desktop Client użyj polecenia Znajdź lub naciśnij klawisze Ctrl+F, aby wyświetlić pasek wyszukiwania. Wpisz szukany fragment tekstu, a następnie użyj klawiszy F3 i Shift+F3, aby znaleźć następne lub poprzednie wystąpienie tekstu. W przypadku programu Web Client możesz użyć funkcji wyszukiwania wbudowanej w przeglądarkę.

Wiesz już jak dodać komentarz, aby opisać sprawę lub dyskutować na jej temat. Długie fragmenty tekstu (np. logi błędów) lepiej jednak zamieszczać w postaci osobnych załączników. W ten sposób możesz również dołączać do sprawy pliki graficzne, dokumenty i inne typy plików, podobnie jak załączniki w wiadomościach e-mail.

Aby dołączyć plik, wybierz polecenie Dodaj załącznik. Następnie wybierz plik, który chcesz dodać, i opcjonalnie wprowadź krótki opis załącznika.

Rysunek 3.16. Dodawanie załącznika

Nowy załącznik jest widoczny w historii sprawy:

Rysunek 3.17. Historia sprawy z załącznikiem

Kliknij odnośnik, aby otworzyć dołączony do sprawy plik lub zapisać go na dysku. Program Desktop Client domyślnie zawsze pyta, czy chcesz otworzyć czy zapisać plik. Możesz również kliknąć prawym przyciskiem, aby wybrać odpowiednią opcję z menu kontekstowego. Zmieniając ustawienia programu możesz wybrać domyślną akcję dla załączników oraz zmienić maksymalną ilość miejsca na dysku przeznaczoną na przechowywanie plików tymczasowych.

W przypadku programu Web Client, w zależności od typu pliku i konfiguracji twojej przeglądarki, kliknięcie na odnośnik spowoduje otwarcie załącznika lub zapisanie go na dysku. Obrazy i pliki tekstowe zwykle zostaną wyświetlone bezpośrednio w przeglądarce. W większości przeglądarek możesz również kliknąć na załączniku prawym przyciskiem, aby wybrać odpowiednią akcję z menu kontekstowego.