Scott Tiger Tech Blog

Blog technologiczny firmy Scott Tiger S.A.

XMLMind & DocBook

Autor: Piotr Karpiuk o 13. lutego 2012

XMLMind to edytor GUI do XMLa o którym wspomniałem w poprzednim poście na temat DocBooka. Dzisiaj więcej o tym edytorze. Przeczytanie tego artykułu zasadniczo zastępuje lekturę liczącej sobie ok. 200 stron dokumentacji programu, i pozwala zacząć tworzyć dokumenty DocBooka.

XMLMind to program napisany w Javie (z biblioteką okienkową Swing), więc daje się uruchomić zarówno pod Windows, Linuksem jak i Mac OS X. Wersja pełna to koszt ok. 1000 zł na stanowisko, zaś w darmowej wersji Personal mamy pewne ograniczenia – najbardziej bolesne z nich to brak sprawdzania pisowni na bieżąco i brak możliwości generowania dokumentacji bezpośrednio z edytora.

Nowy dokument otwieramy poleceniem File/New i wybierając szablon, np. Docbook v5+/Book.

Edycja dokumentu XML w tym narzędziu robi na mnie spore wrażenie swoim pomysłowym podejściem, które nazwałbym prawie-WYSIWYG. W domyślnym widoku edytujemy dokument który bardzo przypomina wygenerowaną postać dokumentacji – podobnie jak w zwykłym procesorze tekstu możemy kopiować i wstawiać fragmenty tekstu za pomocą schowka, za pomocą przycisków na pasku zadaniowym wstawiać tabelkę, obrazek, listę wypunktowaną czy wyróżniać fragment tekstu. Ale jednocześnie cały czas mamy świadomość XMLa który jest generowany pod spodem i chcąc biegle edytować dokument musimy przynajmniej pobieżnie znać DocBooka (jego znaczniki i atrybuty tych znaczników).

W szczególności wiele operacji edycyjnych jest wykonywanych nie tyle na zaznaczonym fragmencie tekstu (z czym mamy do czynienia w zwykłych edytorach), ile na wskazanym (jawnie lub niejawnie) elemencie XMLa edytowanego dokumentu. Element niejawnie wyselekcjonowany (ang. implicitly selected) to najbardziej zagnieżdżony element, w którym aktualnie znajduje się kursor klawiatury. Możemy jawnie wyselekcjonować dowolny element XMLa klikając go w pasku ścieżki (ang. node path bar) wymieniającym wszystkie elementy XML na drodze od aktualnie niejawnie wyselekcjonowanego do korzenia dokumentu:


Czytaj więcej »

Tags: ,
Napisany w Uncategorized | Brak komentarzy »

DocBook

Autor: Piotr Karpiuk o 29. listopada 2011


Wygenerowany z DocBooka format Web Help. Projekt powstał powstał podczas Google Summer of Code 2010. Kliknij aby obejrzeć na żywo.

Dokumentacja produktów firmy informatycznej – w jakim formacie i jak wyobrażamy sobie optymalny proces jej wytwarzania? Często traktowana po macoszemu, powstaje ad hoc w MS Wordzie. Tymczasem chciałoby się mieć:

  • spójny wygląd dokumentów firmy,
  • tak naprawdę przydałyby się różne formaty wynikowe: przynajmniej PDF do wydruku i HTML do dokumentacji online,
  • możliwość przeszukiwania i wygodnego przeglądania wszystkich dokumentów dotyczących jednego produktu, ale może również dokumentów wszystkich produktów firmy,
  • wersjonowanie, z możliwością ustalenia kto, kiedy, gdzie i dlaczego naniósł jakieś poprawki,
  • fragmenty dokumentacji mogłyby być generowane automatycznie, np. z komentarzy w kodzie źródłowym lub ze schematu bazy danych.

Dziś będzie o DocBooku, który moim zdaniem z gracją odnosi się do tak postawionych wymagań. Na początek kliknij w rysunek po prawej, który przedstawia jeden z możliwych docelowych formatów dokumentacji wygenerowanej z tego narzędzia. Zwróć uwagę na pełnotekstowe przeszukiwanie i spis treści w postaci drzewka.

Czytaj więcej »

Tags: ,
Napisany w DTP | Brak komentarzy »