AmigaGuide

\    Alink   AmigaGuide   Apen   Autor   B   Back    Background    Bg   Bpen   Body   Cleartabs   Close   Code   Database    Endnode   Fg   Fill   Font    Help   Height    I    Index   Jcenter    Jleft   Jright   Lindent   Link   Line   Macro   Main    Master    Next   Node   Onopen   Onclose   Par   Pard   Plain   Prev   Quit   Rem    Rx    Rxs   Remark   Settabs   Shadow   Shine    Smartwrap   System   Tab   Tab   Text   Title   Toc   U   Width   Wordwrap    (c)    $ver

AmigaGuide jest aplikacją (skryptem), którą stosuje się głównie do tworzenia plików pomocy w formie tekstowej, przykładowo zawierające instrukcje obsługi danego programu lub gry. Każdy dokument składa się z tekstu i zawartych w nim odnośników, po kliknięciu na które możemy podziwiać ich zawartość na ekranie monitora: teksty, rysunki, itp. AG można, także stosować do innych celów informacyjnych, jego zaletą jest prosty język programowania, który posiada mnóstwo funkcji oraz to, że do jego edycji wystarczy zwykły edytor tekstowy. Należy pamiętać, że rozszerzenie nowo utworzonego pliku powinna być <nazwa>.guide.

Jak każdy hipertekst, AG składa się z różnego rodzaju komend. Wszystkie komendy poprzedzone są tzw. "małpką", czyli znakiem "@" i można podzielić je na dwie grupy: globalne i lokalne (węzłowe). Dodatkowo mamy tu do czynienia z tzw. atrybutami komend, które do poprawnego działania potrzebują danych od piszącego skrypt.

AmigaGuide

 

Przez bardzo długi czas Guide był nie dostępny dla środowiska Pc, chyba że się emulowało Amigę, teraz jeśli ktoś pragnie tworzyć takie aplikacje na Windowsie, wystarczy program WinGuide (Pliki). Do edycji Guide na Pc, potrzebny jest edytor WordPad, nie należy tego robić w Notatniku, ponieważ jest tu inna zasada działania, a zapisany tekst jest niekompatybilny z tym przetwarzanym przez WinGuide. Jedyną wadą programu jest to, że kilka funkcji w ogóle nie działa - cóż może ukaże się nowsza wersja z poprawkami.?

WinGuide

 

Po niżej są przedstawione najważniejsze funkcje języka Guide, choć nie wszystkie, ponieważ metodą prób i błędów nie udało mi się sprawdzić istoty działania większości komend.

Na koniec mała uwaga, do uruchomienia aplikacji niezbędna jest komenda: @database !

Niektóre z poleceń dostępne są jedynie w nowszych wersjach AG i oznaczono to w następujący sposób - jeżeli wymagany jest AG dostarczony z systemem 3.0, na końcu objaśnienia danej komendy znajduje się (30). Natomiast jeśli dane polecenie wymaga AG dostarczonego z systemem 3.1 - na końcu objaśnienia będzie (31).

Funkcje globalne


Funkcje globalne rozpoczynają się znakiem "@", czyli @+komenda. Są to funkcje, informacyjne oraz sprowadzające się tylko do obsługi strony. Pisze się je zawsze z brzegu po lewej stronie. Niektóre komendy stosuje się tylko raz na samym początku edytora, do tych funkcji należą głównie te informacyjne, np.@autor.

ETYKIETA - jest tekstem, który spełnia funkcję adresu.

- Informacyjne:

@AUTOR tekst - informacje o autorze danego dokumentu..

@DATABASE tekst - jest to komenda rozpoczynająca każdy dokument AG. Można powiedzieć, że jest to rodzaj identyfikatora każdego skryptu AG. Jest niezbędna do uruchomienia Guide!

@MASTER tekst - określa katalog dostępu dla oryginalnego pliku tekstowego, z którego został stworzony dany dokument AG (praktycznie nie stosowany).

@REM tekst - komenda ta służy do umieszczania w dokumencie rozmaitych komentarzy.

@REMARK tekst - działa jak @REM.

@(C) tekst - informacje o prawach autorskich.

@$VER tekst - definiuje wersję dokumentu.


- Wykonawcze:

@TITLE tekst - określa tytuł, który wyświetlany jest na listwie okna.

@ENDNODE - określa koniec strony.

@FONT nazwa.font wielkość - służy do ustalenia czcionki, która będzie wyświetlana w dokumencie.

@HELP etykieta - reaguje na przycisk HELP (możliwy odczyt z pliku).

@INDEX etykieta - reaguje na przycisk INDEX (możliwy odczyt z pliku).

@NEXT etykieta - reaguje na przycisk NEXT PAGE (>).

@NODE etykieta "nazwa strony" - określa zaadresowanie strony.

@PREV etykieta - reaguje na przycisk PREVIOUS PAGE {<).

@SMARTWRAP - rodzaj justowania (wyrównywania) wszystkich paragrafów. (31)

@TOC etykieta - reaguje na przycisk CONTENTS, czyli spis treści (możliwy odczyt z pliku).

@WIDTH wartość - oznacza liczbę kolumn w największej stronie.

@HEIGHT wartość - określa liczbę wierszy tekstowych do odczytania w największej stronie.

@WORDWRAP - tekst wychodzący poza obszar wyświetlania, zostanie justowany (wyrównany).

@MACRO etykieta komenda - definiuje makrodefinicję dla aktualnie wyświetlanego tekstu. Składa się ona z przypisań oraz ewentualnie z innych makrodefinicji. Akceptowane przez nie argumenty poprzedzone muszą być znakiem "$", z dopisanym numerem dla każdego parametru (np. "$1", "$2", itd.). Komenda ta jest dość skomplikowana i użycie jej wymaga od piszącego skrypt AG pewnej dozy logicznego myślenia. Przykład użycia:

@{italic "pochyły tekst"}
@MAKRO italic "@{i} $1 @{ui}"

@ONOPEN komenda_ARexxa - pozwala na uruchomienie skryptu ARexxa w momencie otwierania dokumentu. Jeżeli skrypt wyświetli błąd, dokument nie zostanie wykonany. (31)

@ONCLOSE komenda_ARexxa - działanie jest podobne jak w przypadku @ONOPEN, z tą różnicą że skrypt ARexxa zostanie uruchomiony w momencie zamykania dokumentu. (31)

@TAB wartość - tabulator (domyślnie jest 8). (31)

@RX komenda - wykonuje zadany skrypt ARexxa.

@RXS komenda - wykonuje ARexxowy tzw. string file.

 

Funkcje lokalne (węzłowe)


Funkcje te obejmują swym działaniem wybrany obszar, wyróżnia się je przez: @{funkcja (lub i 2)}. Stosuje się głównie między podanym tekstem, za wyjątkiem przycisku.

\ 
"backslash" także jest komendą. Dzięki niemu mamy możliwość wyświetlenie w tekście znaku "@". Jeśli chcemy uzyskać w dokumencie znak "\", musi on także być poprzedzony slashem.

ALINK
@{"nazwa przycisku" ALINK etykieta linia} - działa jak LINK, ale w nowym oknie. Możliwe jest także wgranie pliku z tekstem lub obrazkiem.

AMIGAGUIDE
@{amigaguide} - wyświetla pogrubiony napis "AmigaGuide". (31)

APEN
@{apen wartość} - zmienia kolor tekstu. (31)

B
@{b}tekst @{ub} - włącza pogrubienie tekstu* (30)

BACK
@{rozszerzenie back} - kończy działanie funkcji z rozszerzeniem.

BACKGROUND
rozszerzenie - zmienia na kolor tła.

BG
@{bg rozszerzenie} - operacje na tle tekstu.

BODY
@{body} - ustawia standardowy format tekstu. (31)

BPEN
@{bpen wartość} - zmienia kolor tła tekstu. (31)

CLEARTABS
@{cleartabs} - ustawia standardowy rozmiar tabulacji. (31)

CLOSE
Zamyka okno otwarte przez ALINK. (30)

CODE
@{code} - włącza jednocześnie trzy parametry: JCENTER, JLEFT, JRIGHT. (31)

FG
@{fg rozszerzenie}- operacje na tekście.

FILL
rozszerzenie - zmienia na kolor błękitny.

I
@{i}tekst @{ui} - przechylenie tekstu* (30)

JCENTER
@{jcenter} - wyśrodkowanie tekstu. (31)

JLEFT
@{jleft) - tekst po lewej. (31)

JRIGHT
@{jright} - tekst po prawej. (31)

LIDENT
@{lindent wartość} - tworzy akapit z odstępem "n" znaków, dla tekstu jednoliniowego przekraczającego ekran. Tekst wychodzący poza obszar ekranu jest przenoszony z lewym akapitem. Wyłączenie funkcji to @{lindent 0}. (31)

LINE
@{line} - powoduje wstawienie w dokument przy wyświetlaniu pustej linii bez rozpoczynania paragrafu. (31)

LINK
 @{"nazwa przycisku" LINK etykieta linia} - umożliwia skok do strony o podanej etykiecie. Efektem działania tej komendy jest wyświetlenie prostego przycisku. Możliwe jest także wgranie pliku z tekstem lub obrazkiem.

MAIN
@{"nazwa przycisku" LINK plik/main} - wyświetla tekst lub obrazek w nowym oknie (?).

PAR
@{par} - używany ze @SMARTWRAP, jest odpowiednikiem dwóch pustych linii. (31)

PARD
@{pard} - przywraca standardowe parametry paragrafu: APEN 1, BPEN 2, LIDENT 0 i standardową czcionkę. (31)

PLAIN
@{plain} - rozkaz ten odwołuje wszelkie parametry wizualne związane z tekstem (pogrubienie, pochylenie...). (31)

QUIT
rozszerzenie - powoduje zamknięcie aktywnego dokumentu AG. (>30)

SETTABS
@{settabs wartość....wartość} - ustawia serię tabulacji ze skokami o kolejne "wartości" spacji. (31)

SHADOW
rozszerzenie - zmienia na kolor szary.

SHINE
rozszerzenie - zmienia na kolor biały.

SYSTEM
@{"nazwa przycisku" SYSTEM plik} - wykonuje komendę AmigaDos, np. uruchomienie programu.

TAB
@{tab} - sprawia, że na wyjściu będą widziane znaki tabulacji zamiast spacji.

TEXT
rozszerzenie - przechodzi do tekstu.

U
@{u}tekst @{uu} - podkreślenie tekstu* (30)

 

* przedrostek "u" określa zakończenie operacji na tekście.

Przykłady

 

Pogrubienie tekstu:

@database TEST.guide
@node Strona1 "Okno"

    @{b} To jest test @{ub}

@endnode

 

Tekst na kolor błękitny:

@database TEST.guide
@node Main "TEST"

    @{fg fill} To jest test @{fg back}

@endnode

 

Przycisk ze skokiem do nowego okna:

@database TEST.guide
@autor ULISSES 32
@node Menu "Menu"

    @{"Okno 2" link Nowy}

@endnode
@node Nowy "Nowe okno"

    Ok.

@endnode

<

^