[Korzystajâc z okazji, ûe jestem tu czymô w rodzaju redaktora,
pozwoliîem sobie w ohydny i pozbawiony jakichkolwiek resztek moralnoôci
sposób wepchnâê reklamë mojego wîasnego produktu. Jeôli nie chcecie,
nie czytajcie, zostaliôcie ostrzeûeni - Jubal]
taintoo.readme, wersja 0.13 :)
Ano kiedyô trzeba bëdzie zaczâê pisaê të dokumentacjë, pomyôlaîem. I
oto jest. A w kaûdym razie jej poczâtek i kawaîek ciâgu dalszego.
1. WSTËP, SPRAWY OGÓLNE I INNE TAKIE...
"TaInToo" to odrobinë nienaturalny skrót od angielskiej nazwy "HTML
Tags Inserting Tool", co dosyê dobrze oddaje funkcjë, jakâ ma speîniaê
ten programik - czyli narzëdzie do wstawiania tagów HTML (jëzyka opisu
strony hipertekstowej) do obrabianego tekstu. Co to jest HTML tîumaczyî
nie bëdë - odsyîam do odpowiedniej literatury. (Na przykîad do ksiâûki
Wîodzimierza Macewicza "Jëzyk skîadu dokumentu hipertekstowego HTML i
HTML+", moûna takûe skorzystaê z poradnika Huckstera, zamieszczonego w
MA /choê Huck jest lama, bo pokazaî tag <blink>, którego nie cierpië/,
moûna wreszcie poczytaê o tworzeniu HTML-i w nowym facie /nr 19/).
DO URUCHOMIENIA PROGRAMU NIEZBËDNE SÂ:
· OS 2.04+
· zainstalowany pakiet VAREXX w wersji 1.6+
· biblioteka reqtools (wersja 38+)
· biblioteka rexxreqtools (wersja 37.95+)
· aktywny serwer REXXA w systemie
· okoîo 170 KB wolnej pamiëci
DO UÛYWANIA PROGRAMU NIEZBËDNE SÂ:
· wszystko, co wymieniono powyûej
· uruchomiony edytor tekstu - jeden z niûej wymienionych:
· Cygnus Editor (wersja 3.5+)
· AmiTekstPro (wersja 2.1)
DO STOSOWANIA PROGRAMU PRZYDATNE SÂ:
· niewielka (co najmniej) wiedza na temat HTML
· chwila czasu
· trochë gotowych tekstów zapisanych w formacie ASCII
1A. INSTALACJA
ach, instalacja... jest doprawdy banalna - wystarczy rozpakowaê gdzieô
to archiwum (a przecieû, jeôli to czytasz, to juû jest rozpakowane) -
to wszystko; Oczywiôcie wypada mieê zainstalowany VAREXX; ale to juû
napisaîem...
1B. PRAWA AUTORSKIE I INNE BLABLA ;>
Program - w wersji tzw. "uûywalnej bardzo beta" - ma status giftware.
To oznacza, ûe jeôli sië komukolwiek spodoba, moûna na mój adres
przesyîaê dary, podarki i datki dowolnej wartoôci - moûe to byê np.
zarejestrowana wersja programu shareware, jeôli ktoô taki akurat
rozprowadza, moûe teû byê nowy Amiga Odkurzacz (Walker), w zupeînoôci
jednak wystarczy e-mail lub kilka ciepîych sîów na IRC. A jeôli nie
dostanë nic, to teû sië przesadnie nie zmartwië - choê ûyczë takim
sknerom zîego snu ::).
NIE BIORË ÛADNEJ ODPOWIEDZIALNOÔCI ZA JAKIEKOLWIEK SZKODY, KTÓRE
MOGÎYBY ZOSTAÊ WYRZÂDZONE W OBECNOÔCI URUCHOMIONEGO SKRYPTU (CHOÊ NIE
UWAÛAM, BY MÓGÎ SIË ON DO NICH W JAKIKOLWIEK SPOSÓB PRZYCZYNIÊ). NIE
MAM NIC WSPÓLNEGO ZE SZKODAMI - ZARÓWNO NA CIELE, JAK I NA UMYÔLE
UÛYTKOWNIKA - KTÓRE MOGÎYBY ZOSTAÊ SPOWODOWANE NIEUMIEJËTNYM
KONTAKTOWANIEM SIË ZE SKRYPTEM.
1C. PRZYSTOSOWYWANIE SKRYPTU DO PRACY Z INNYMI EDYTORAMI
Uwaga: ten skrypt pracuje aktualnie z cedem i amitekstem pro (wersja
2.1+). Jeôli chcesz go przystosowaê do innego edytora, moûesz to
zrobiê, dopisujâc odpowiednie fragmenty kodu do procedur z pliku
ed-procs.rexx, który znajduje sië w katalogu ze skryptem. Proces
przystosowywania procedur jest opisany w owym pliku. Aby doîâczyê swoje
procedury do TaInToo, musisz mi je przesîaê (w postaci pliku
ed-procs.rexx z naniesionymi poprawkami) - najlepiej e-mailem, na adres
baran@sun10.ci.pwr.wroc.pl. Moûna teû zwykîâ pocztâ, na adres:
Mirosîaw L. Baran
ul. Dokerska 22/3
54-142 Wrocîaw
Osoby, które nadeôlâ mi takie rozszerzenia, majâ mojâ wieczystâ
wdziëcznoôê, miejsce na liôcie wspóîautorów, sâ teû zwolnione od
moralnego obowiâzku podarowania mi czegokolwiek ;>>
1D. AHA - I JESZCZE JEDNA SPRAWA:
· Pakiet VAREXX w wersji 1.6 jest autorstwa Andrew Cooka
· biblioteka rexxreqtools jest autorstwa Rafaela d'Hallewyn
· biblioteka reqtools jest autorstwa Nico Francois i Magnusa Holmgrena
· GadToolsBox, przy pomocy którego zrobiîem GUI do skryptu, jest
autorstwa Jana van den Baarda.
1E. POZDROWIENIA
- imienne dla wszystkich Dam z #AmigaPL, alfabetycznie, dla:
· Beby
· Iz (obu)
· Katki
· _Leo_
· LMouse
- zbiorcze, dla caîej reszty kanaîowych szczurów :) oraz
Alchemików, gdziekolwiek by nie byli :), a takûe dla wszystkich
innych, tutaj nie wspomnianych...
1F. MUSIAÎEM TO TUTAJ WSTAWIÊ...
_ _ __.___
|_|| | '|_||_ | | ||_|
| ||_|_.| ||__| | | _|
_ _
|_||_||\ ||_| |
| | || \| _| O
2. URUCHAMIANIE I PRACA Z TAINTOO
Aby uruchomiê skrypta, trzeba odpaliê go z poziomu edytora, po
uprzednim zainteresowaniu sië zawartoôciâ pliku .taintoorc, gdzie
naleûy ustawiê wîaôciwy ekran, nazwë edytora ('ced' lub 'atp2.x').
Skrypt MUSI byê uruchamiany asynchronicznie; jeôli edytor nie robi tego
sam, trzeba mu w tym pomóc i wpisaê w requesterze wywoîujâcym go:
'run rx Dysk:ôcieûka/dostëpu/taintoo-0pl27/TaInToo-0pl27'
TaInToo jest wîaôciwie rexxowâ nakîadkâ na edytor tekstów, uîatwiajâcâ
tworzenie dokumentów w formacie HTML. Skrypt otwiera na podanym ekranie
publicznym swoje okienko, w którym znajduje sië kilka (8) gadûetów.
Okienko wyglâda mniej wiëcej tak:
+--+-------------------------------------------------+---+
|[]| TaInToo 0pl25 Catastrophic Window |[]]|
+--------------------------------------------------------+
| +--------------------------------------+ |
| (o) Odsyîacze |Odsyîacz telnetowy |#| |
| o Grafiki |Odsyîacz do pliku |#| |
+----->| o Edycyjne |Odsyîacz... |#| |<----+
| | o Listy | |#| | |
| | o Formularz | |-| | |
| | o Inne | ||| | |
| | | |-| | |
| | | ||| | |
| | +--------------------------------------+ | |
| | +-------+ +-------+ +------+ +------+ +------+ +-----+ | |
| | | Opraw | | Ustaw | | Info | |Otwórz| |Zapisz| |Wyjdú| | |
| | +-------+ +-------+ +------+ +------+ +------+ +-----+ | |
| +--------------------------------------------------------+ |
| |
| |
+----- gadûet z dostëpnymi grupami tagów (MX) |
|
peîna lista tagów z danej grupy -----+
(listview)
Przyciski u doîu okna oznaczajâ kolejno:
· "Oprawienie" dokumentu w globalne tagi HTML; nadanie mu tytuîu etc.
· Wywoîanie okna konfiguracyjnego
· Wyôwietlenie requestera z informacjâ o programie
· Wczytanie nowego dokumentu
· Zapisanie dokumentu (w nastëpnych wersjach, teraz nieaktywny)
· Wyjôcie z programu (to samo, co gadûet CLOSE w górnym lewym rogu okna)
Skrypt obsîuguje sië banalnie - klikajâc na gadûetach, albo teû
uûywajâc shortcutów. Zmiana grupy tagów nastëpuje po klikniëciu na
któryô z przycisków lub teû - z klawiatury - po naciôniëciu TAB lub
kursor w prawo. (Kursor w lewo cofa o jednâ grupë do tyîu.) Po liôcie z
dostëpnymi tagami moûna poruszaê sië przy pomocy klawiszy kursora - w
dóî i w górë. Przyciôniëcie klawisza RETURN jest równoznaczne z
klikniëciem na wybranâ z listy pozycjë, powoduje jej wybranie i
wstawienie tagu do tekstu.
3. WSTAWIANIE TAGÓW
3.1 TAGI ZWYKÎE
Aby zaznaczyê tag, naleûy zaznaczyê blok, lub ustawiê kursor na
sîowie, które ma zostaê otoczone tagiem, potem wybraê odpowiedni
znacznik HTML ze spisu.
Skrypt dziaîa w trojaki sposób:
· Jeôli wybrany tag jest jednoczëôciowy (jak np. tag <hr>), wstawia go
w pozycji kursora, lub na koïcu zaznaczonego przez nas bloku.
UWAGA! Tagi jednoczëôciowe sâ wstawiane na pozycji kursora, zatem
jest moûliwe wstawienie tagu w ôrodek sîowa, jeôli tam akurat
znajduje sië kursor.
· Jeôli tag skîada sië z czëôci otwierajâcej i zamykajâcej (np.
<h3></h3>), wtedy albo zostanie nim oblane sîowo, na którym znajduje
sië kursor, albo teû zaznaczony blok. Trzeba pamiëtaê, ûe blok ma
absolutny priorytet, to znaczy, ûe jeôli zaznaczymy jakikolwiek blok
i wybierzemy któryô z tagów do wstawienia, to zostanie oblany caîy
zaznaczony blok.
· Sâ takûe tagi, które wymagajâ zaznaczenia bloku, w przypadku
niezaznaczenia tegoû ukaûe sië requester z uprzejmâ propozycjâ
"Najpierw zaznacz blok."
3.2 TWORZENIE LIST
Tworzenie list róûni sië nieco od normalnego wstawiania tagów. Aby nie
byîo ono nazbyt mëczâce, trochë je zautomatyzowaîem. Wymaga to niestety
pewnego przygotowania tekstu przed rozpoczëciem wstawiania tagów:
3.2.1 LISTY ZWYKÎE
Listy zwykîe, to wszystkie listy poza definicyjnymi. Aby utworzyê takâ
listë, naleûy umieôciê jej elementy w osobnych liniach, oddzielonych od
siebie pustâ liniâ, lub zaczynajâcych sië od dowolnego biaîego znaku
(spacji, tabulatora) - i wtedy pusta linia oddzielajâca elementy nie
jest potrzebna. Jeôli kilka kolejnych linii nie jest oddzielonych od
siebie przy pomocy pustej linii i nie rozpoczyna sië od biaîego znaku,
sâ one uznawane za jeden element listy. Po wpisaniu elementów naleûy
zaznaczyê blok na obszarze tekstu, który ma zostaê listâ i wybraê ze
spisu dostëpnych tagów listowych ten, który jest nam potrzebny (np.
listë nienumerowanâ).
np.:
Jacek
Agatka
January
po potraktowaniu skryptem bëdâ wyglâdaê tak:
<ul>
<li>Jacek
<li>Agatka
<li>January
</ul>
zaô lista:
Jacek
Agatka
January
bëdzie wyglâdaê tak:
<ul>
<li>Jacek
Agatka
<li>January
</ul>
3.2.2 LISTY DEFINICYJNE
Listy definicyjne muszâ skîadaê sië z serii okreôleï i nastëpujâcych po
nich definicji (opisów - w postaci jednego bloku), wszystko to
oddzielone od siebie pustymi liniami, np.:
Lato
Lato, jak wiadomo, jest lamerskâ porâ roku, nadajâcâ sië tylko i
wyîâcznie do pracy w pogotowiu
Zima
Zima jest nieprzyjemna tak bardzo, jak tylko potrafi. Nie lubimy jej za
to serdecznie. No, chyba, ûe akurat pada ônieg, jest lekki mróz, ale
nikt w pobliûu nie îamie sobie nogi...
co po dodaniu tagów bëdzie wyglâdaîo tak:
<dl>
<dt>Lato
<dd>Lato, jak wiadomo, jest lamerskâ porâ roku, nadajâcâ sië tylko i
wyîâcznie do pracy w pogotowiu
<dt>Zima
<dd>Zima jest nieprzyjemna tak bardzo, jak tylko potrafi. Nie lubimy jej za
to serdecznie. No, chyba, ûe akurat pada ônieg, jest lekki mróz, ale
nikt w pobliûu nie îamie sobie nogi...
</dl>
Aby stworzyê listë definicyjnâ, naleûy zaznaczyê blok tekstu i wybraê
ze spisu znaczników ten, który wstawia wîaônie takâ listë.
3.3. TAGI SÎUÛÂCE DO TWORZENIA FORMULARZY
Jeszcze nie zrobione.
4. DODAWANIE WÎASNYCH TAGÓW
Istnieje moûliwoôê dodania wîasnych tagów - do grupy "Inne" - trzeba
tylko wyedytowaê plik taintoo_own.def, gdzie znajdâ sië tagi zapisane w
tej samej skîadni, jak w pliku taintoo.def. Lokalizacja pliku
taintoo_own.def jest zasadniczo dowolna - skrypt próbuje go îadowaê
albo z bieûâcego katalogu, albo z katalogu, w którym sam sië znajduje.
Mirosîaw L. Baran
Jubal/Alchemy
baran@sun10.ci.pwr.wroc.pl
Wrocîaw, 10. VI 1896