Using Amaya

    amaya [-display host] [document]

New columns can be created very efficiently with the Return key. Move the insertion point to the end or the beginning of a cell (for example at the end of Cell 1.1 in the table below). By hitting the Return key twice (the first hit creates a paragraph in the current cell) you create a new cell and its corresponding column, as shown below:

Caption

Cell 1.1	I	Cell 1.2	Cell 1.3
Cell 2.1

Adding a new row, a new tbody

To create a new row, press Return three times when the insertion point is at the end of the last cell in a row (in Cell 1.3, for instance). You can also select the row by hitting the ESC key and pressing Return only once.

To create a new tbody, press Return four times (or three times if the cell is empty) and one time more to create a new paragraph after the table.

There is no specific command to create a new column. When you create a new cell, Amaya generates the corresponding new column. When you delete a cell in a column that becomes empty, Amaya deletes the column automatically. But there is a specific command (Delete table column) to delete a column, even if it's not empty. This command is located at the end of submenu Table of menu Types.

Note that the table model implemented in Amaya is the HTML 4.0 model. This includes features such as multiple bodies (tbody), header (thead) and footer (tfoot).

 

---

8. Client-side image maps

[ImageMaps.html]

Using client-side image maps

Amaya allows you to use client-side image maps.

• To activate an area in a map, double-click on the area with the left mouse button. The URL attached to this area is then fetched.
• To display existing areas, choose Show Map Areas from the Views menu.

Creating client-side image maps

To create a new image map, you must create the image element first, either by choosing Image from the Types menu or by clicking on the button. This brings up a dialog box that lets you enter the file name of the desired image.

To create an area in a image, select the image or an existing area of that image. Then choose Rectangle, Circle, Polygon from the Area Map submenu of the Types menu, depending on the shape of the new area you want to create.

• To create a rectangular or circular area, you must first select the position of one corner by pressing the left mouse button. Keep the button pressed down and move to the position of the opposite corner, then release the button. The area is now defined.
• For a Polygon, enter each point by clicking the corresponding position with the left mouse button. To indicate the last point, click with the middle button.

When the area has been defined, you must enter the target of the link associated with that area. Just click on the target (or enter its URL if it is not displayed), in the same way as you create links.

Moving image map areas

When the area has been defined, you can move this area:

• Either by direct manipulation - combining the Control key with the Left button of the mouse within an area of image map allows you to move this area;

• Or by editing the coords attribute of the area in the Structure View.

Resizing image map areas

• Either by direct manipulation - combining the Control key with the Middle or the Right button of the mouse within an area of image map allows you to move this area;
• Or by editing the coords attribute of the area in the Structure View.

 

---

9. Style Sheets

[StyleSheets.html]

The Style menu allows you to change the appearance of your documents by two different means:

• using Cascading Style Sheets (CSS),
• using HTML elements and attributes.

The first entries of the Style menu are dedicated to CSS, the last two entries to HTML elements.

Cascading Style Sheets

Creating and updating Style attributes

Each of the first four entries of the Style menu call a dialog box that allows you to associate a style attribute with the currently selected elements:

• Character Style allows you to choose the font family, the character style, the body size and the underline style.
• Colors allows you to choose the foreground and background colors from a palette. Click on a palette cell with the left button to set the foregroud color, click with the middle button to set the backgroud color.
• Format allows you to set alignment, indentation, justification and linespacing.
• Background Image allows you to choose a background image and its repeat mode.

In all these dialog boxes, Default buttons allow you to remove the corresponding style information from the selected elements.

All modifications made with these dialog boxes can be viewed immediately in both the WYSIWYG view and the Structure view.

Changing width and height of elements

The width and height of any element in a document can be changed interactively, in the same way as image map areas. By pressing the Control key on the keybord and the middle button of the mouse, you can resize the box associated with the element under the cursor. When you release the mouse button, the element size is changed and a style attribute is associated with the element.

When the resized element is an image, this image is zoomed to fill its new box.

Creating, updating and using classes

When a style attribute has been associated with an element, you can use that element as a model for creating or modifying a style rule. Select this element (you must select only one element and this element must have a style attribute) and choose Create Rule from the Style menu. A dialog box pops up that displays a list of CSS selectors. This list comprises all classes that are defined for the current document as well as, the element types to which some style is associated.. Choose a selector in this list or enter a new class name or type name and press the Confirm button. The style of the selected element is then associated with the chosen selector and the style attribute is removed from the selected element. Its content is moved to the STYLE element, in the document HEAD, and all elements matching the selector are displayed with the new style.

When you have created new classes with the Create Rule command, you can associate these classes with some elements in the document document. Choose Apply Class from the Style menu. A dialog box pops up which displays all existing classes. Choose one of these classes. The selected elements are then displayed with the style associated with the chosen class.

To associate a class with an element, you can also use the Attributes menu. This menu allows you to delete a class attribute from an element or to change it: the class attribute is handled like any other attribute.

Style through HTML elements

HTML provides some character-level elements that allow you to associate style with character strings. Two entires from the Style menu allow you to handle these HTML elements.

Editing style sheets

Commands Create Rule and Apply Class provide the basic functionality for manipulating style information. More complex manipulations can be made with the CSS dialog box. You can get that dialog box by clicking the CSS button or by selecting Style sheets from the Style menu.

The CSS dialog box allows you not only to edit the content of a style sheet, but also to create new sheets and to update existing ones by copying rules from one sheet to another.

• The two CSS file selectors allow to select the style sheets from which rules can be manipulated. In each selector, the currently selected sheet is highlighted.

  Entry Document style represents the set of rules gathered in the STYLE element, in the document HEAD.

  Entry User's preference represents the user style sheet (file .amaya.css in the user's home directory)

• The two rule selectors show the rules from the selected style sheets. In fact, they only display the selector part of these rules. Only one rule can be selected for both selector, which is the current rule, displayed in the text area below.
• The text area at the bottom shows the complete current rule (the one selected from the rule selectors), allowing the user to see and edit the CSS syntax.
• Between the two rule selectors there is a column of 5 buttons.
  • pushing the button merges the current rule (as shown in the text area) to the second style sheet. Changes are immediately reflected in the WYSIWYG View.
  • pushing the button copies the current rule to the second style sheet.The difference with the previous button is that all rules using the same selector initially present in the file are first removed.
  • pushing the button deletes the current rule from its style sheet.
  • the buttons and have the same effect as the first two buttons but they act on the first style sheet..
• The five buttons at the bottom are used for handling style sheets.
  • Save initiates the operation of saving all modified style sheets.
  • Save as saves one of the style sheets to a local file.
  • Reload is a coarse grained Undo. It reloads all the modified style sheets referenced by the document.
  • New adds an external style sheet to the list of the external style sheets referenced by the document. It is also possible to browse the content of a file without attaching it to the document. Amaya keeps an history of the style sheets encountered. This history is saved from session to session, and allows you to grab quickly one of the style sheets lastly referenced, to browse its rules or to attach it to the current document.
  • Remove supresses a reference to an external style sheet.
  • Cancel closes the CSS dialog box.

Creating HTML style elements

Entry Information type from the Style menu presents a submenu offering a choice of HTML elements that define abstract styles. Select first a character string in your page and then choose an item in this menu. The selected character string receives the corresponding style. Three of these styles are also available through buttons: emphasis (button i), strong (button B) and code (button TT).

Entry Character elements from the Style menu offers another menu for changing the style of text. Most entries of this menu could be replaced by CSS and should not be used. They are here only for the sake of completeness of the HTML 3.2 implementation.

Removing style

To remove style from a character string, select the string first and re-apply the command that was used for associating the style you want to remove. All commands in the submenus Information Type and Character Element toggle themselves if re-applied.

 

---

10. Editing attributes

[Attributes.html]

There are two ways to edit attributes:

• the Attribute menu,
• the Structure view.

Editing attributes through the Attribute menu

The Attribute menu lists all attributes that can be associated with the selected element. It can be used to create an attribute, to change the value of an existing attribute or to delete an attribute.

To edit an attribute, first select the appropriate element. You must select the entire element, not simply a character within the element; use the Esc key for this. When the element is selected, choose the attribute to be edited from the Attributes menu. Then Amaya acts according to the chosen attribute:

• If it is a boolean attribute (such as ismap for an image), the command is finished. Choosing that attribute in the menu removes it from the selected element, if it is present, or adds it if not.
• If is is an attribute with a limited set of values (such as align for a paragraph or a heading), a dialog box pops up. It contains a menu of the available values and three buttons.
  • If you want to create this attribute or to change its value, choose the desired value from the menu and click on the Apply button.
  • If you want to remove that attribute, click on the Delete button.
• If it is an attribute with a free value (such as href for an anchor), a dialog box pops up. In this dialog box, you can edit the attribute value; terminate the command with the Apply button. To remove the attribute, click on the Delete button.

Editing attributes in the Structure view

All attributes are displayed in the Structure view. Attributes whose value can be chosen freely are displayed in black and you can edit their value like any other character string. When the attribute value is displayed in blue, you can only change it with the Attribute menu. This ensures that only one of the correct values is chosen.

 

---

11. Editing mathematics

[Math.html]

Amaya allows you to include mathematical expressions in web pages, following the Mathematical Markup Language (MathML) specification. Mathematical expressions are handled as structured components, exactly in the same way as HTML elements. Therefore, you can manipulate math expressions in the same way you manipulate other parts of HTML documents. All editing commands provided by Amaya for handling text are also available for math, and there are some additional controls to enter mathematical constructs.

Creating a math expression

The Math palette and the Types/Math menu

To create a mathematical expression in a document, just move the insertion point (the caret) to the position where you want to insert that expression, and click the Math button (the rightmost button), or select the last entry (Math) from the Types menu. The Math button displays a palette that stays on the screen until you click the Done button. Item Math from the Types menu displays a popup menu. Just choose the most convenient tool. Both allow you to select the mathematical construct to be inserted.

In the Math palette (or menu) the first item allows you to create a new formula when the caret is in some HTML element (but the caret should not be within a MathML element):

The next items of the Math menu (or palette) allow you to create new constructs within a formula. If the caret is not in a formula, a Math element is created first to accept the new construct. The available constructs are, from top to bottom:

• Root with index, mroot in MathML: $\sqrt[3]{x+1}$
• Square root, msqrt: $\sqrt{x+1}$
• Fraction, mfrac: $\frac{1}{x+1}$
• Expression with subscript and superscript, msubsup: $x_{i+1}^n$ or ${\int }_0^{\infty }$
• Expression with a subscript, msub: $x_i$
• Expression with a superscript, msup: $x^n$
• Expression with under- and overscript, munderover: $\sum _{i=1}^n$
• Expression with underscript, munder: $\underset{-}{x}$
• Expression with overscript, mover: $x\stackrel{\text{maps to}}{\to }y$
• Expression within parentheses, mrow: $\left(a+b\right)$
• Expression with prescripts and tensor indices, mmultiscripts: ${}_k{}^{l}X_i^j$
• Matrix or table, mtable: $\begin{array}{cc}a& b\\ c& d\end{array}$

The last item of the Math palette ($\mathrm{\alpha \beta \gamma }$ ) displays another palette from which you can insert mathematical symbols and greek characters.

Entering constructs from the keyboard

You are not obliged to use a menu or a palette to create and edit mathematical expressions. You can enter mathematical constructs directly from the keyboard, as each item in the Math menu has a keyboard equivalent (all shortcuts are listed in the menu). This allows you to type faster. To type even faster, you may also use the keyboard to move the caret from a construct to another, with the arrow keys.

Entering characters

When you type a character string in a MathML element, Amaya parses that string and generates elements mo (operator), mn (number), mi (identifier), and mtext automatically. For instance, to enter

$x=2a+b$

just type x=2a+b, (don't forget to first click on the Math item of the Math menu, if you are not in a mathematical expression) and you will get the following structure (you can check in the Math_Structure view):

<mi>x</mi><mo>=</mo><mn>2</mn><mi>a</mi><mo>+</mo><mi>b</mi>

Structure editing

Amaya provides the same method to create and edit matrices as to edit HTML tables. Like for tables there is a specific command (Delete matrix column) to delete a column in a matrix, even if it's not empty. This command is located at the end of submenu Math of menu Types.

You may want to change the structure of an existing expression, e.g. appending a superscript or puting parentheses around an expression. To do that, just select the expression and enter the new construct with the palette, the Math menu or the keyboard.

You can also use the Transform command from the Special menu. Select the expression you want to transform and the Transform command will display a menu with all possible changes.

Math_Structure view

Whenever a document contains some MathML elements, choosing the Show Structure item from the Views menu actually opens two views:

• the Structure view shows the main structure of the HTML document. In this view, MathML elements are only represented by a MATH tag and their actual contents is not shown.
• the Math_Structure view shows only MathML elements, but here, all their components are visible.

You can edit math expressions either in the main view or in the Math_Structure view. The Math_Structure view is especially helpful to avoid ambiguity. Consider the following example:

$$x=\sqrt{a+b}+1$$

When moving the caret after character b, it is not clear whether you want to add something within the square root or after it. Selecting (or checking) in the Math_Structure view avoids any ambiguity.

Links in MathML

You can create and use links in mathematical expressions. These links are represented in the XML Linking Language (XLink). Only the simple unidirectional hyperlinks are available, but you can associate a link with any part of a formula. For example, the fraction in the formula below is a link to the W3C home page:

$y=\frac{1}{\sqrt{x^2+1}}$

Double-clicking any character within the fraction fetches the W3C home page. In the XML file, the fraction is represented by:

<mfrac xml:link="simple" href="http://www.w3.org/">...</mfrac>

To create such a link, just select an expression (the fraction in the above example), click on the Link button (or select "createLink" from the Links menu) and click on the desired target. If the target is an expression in a formula, you first have to turn that expression into a target. Just select the expression and select "create Target" from the Links menu. This creates an id attribute for the target expression.

Current limitations

Amaya implements only the Presentation Tags from MathML, not the Content Markup. All presentation elements are available, but only some MathML attributes are currently implemented (for instance fontstyle which is available in the Attributes menu when a mi element is selected). However, the class, id and style attributes are available, with the same semantics as in HTML: you can associate CSS style with MathML elements (class and style attributes) and a MathML element can be the target of a link (id attribute).

Only a limited set of entities representing math symbols are recognized by the parser, mainly those available in the Symbol font. The current version supports: Therefore, SuchThat, DownTee, Or, And, Not, Exists, ForAll, Element, NotElement, NotSubset, Subset, SubsetEqual, Superset, SupersetEqual, DoubleLeftArrow, DoubleLeftRightArrow, DoubleRightArrow, LeftArrow, LeftRightArrow, RightArrow, Congruent, GreaterEqual, le, NotEqual, Proportional, VerticalBar, Union, Intersection, PlusMinus, CirclePlus, Sum, Integral, CircleTimes, Product, CenterDot, Diamond, PartialD, DoubleDownArrow, DoubleUpArrow, DownArrow, UpArrow, ApplyFunction, TripleDot.

 

---

12. Searching and replacing text

[Searching.html]

You can search and replace text with the Search dialog box. Call this box by choosing Find from the Edit menu or click on the corresponding button .

This form allows you to search or replace text using different criterions:

• The character string to be searched for must be entered in the Search for input area.
• If the UPPER=lower button is selected, a case-insensitive search is performed; otherwise, the string is searched for as it appears within the "Search for" input area.
• Strings can also be replaced using the same operation. The replacement text is entered in the Replace by input area and a replacement mode is selected from the Replace menu. The replacement modes are as follows:
  • No replace: no replacement occurs even if the ``Replace by'' input area contains a character string. It is just a simple search.
  • Replace on request: when the string is found, it is selected. The user can then select one of the following buttons:
    • Confirm to replace and carry out the search again.
    • Do not replace to search for the next instance without replacing the string which has been found.
  • Automatic replace: all instances of the string searched for are automatically replaced within the portion of document defined in the "Search where" menu.
• The Search where menu allows you to specify the part of document in which the search occurs:
  • Before selection: the search starts at the beginning of the selected part and moves backwards to the beginning of the document.
  • Within selection: the search only occurs within the selected part, from its beginning to its end.
  • After selection: the search starts at the end of the selected part and moves forwards to the end of the document.
  • In the whole document: the search is carried out in the whole document from the beginning to the end regardless of which part is selected.

To initiate the search operation, click on the Confirm button at the bottom of the form. If the string searched for is found, it is selected and the document is positioned so as to make this string visible; you can then search for the next instance of this string by selecting the Confirm button again. If the string is not found, the "Not found" message appears in the bottom right-hand corner of the form.

Search or replace can be abandoned at any moment by clicking on the Done button.

Note: the replacement operations cannot be undone (there is no "Undo" command in this version).

 

---

13. Saving and Publishing documents

[Publishing.html]

Amaya allows you to save documents either in HTML or as text.

Remote and local saving can be accessed in two ways, through the Save and SaveAs commands.

Saving documents in HTML

Amaya doesn't provide any global view of the set of pages installed on a server. However it is possible to save files to a remote server as to local files through the Save and SaveAs commands. During these operations, Amaya takes images into account.

The Save command

The save command can be invoked either by choosing Save from the File menu or by clicking on the button. This command saves the current document to the location it was fetched from. Newly added images are saved in the same directory and no confirmation is asked except if the document name is unknown. Servers allow users to fetch a document when only the server name or the server directory name is given. This is very useful at browsing time, but it is not supported by the put method. In this case, Amaya detects that the document name is missing and proposes to use a default name or to complete the request.

If one need to save newly added images to a different location, the Save As command should be used instead.

The Save As command

Selecting the Save As entry in the File menu opens a dialog box that allows you to save the current document to a different location, a remote Web server or the local file system. You can:

• save the document to a local disk,
• save the document to a remote URL,
• save images embedded in the document in the document directory or a different location,
• transform embedded URLs,

The items in the dialog box, from top to bottom, left to right are used as follows:

• The Document directories selector shows the directories contained in the current directory. It should be used to save a file on the local file system.
• The Files selector shows the files contained in the current local directory.
• The HTML and Text toggles are exclusive. The default is HTML and you have to change it, if you want to produce a text form of the current document.
• The Copy Images toggle indicates whether the images embedded in the current document must be copied along with the document to the new location. It's generally better to let this switch on since otherwise you are not sure that the corresponding images will be found when opening the document later. However switching it off is useful when you have only changed the text of the document and the document is stored on the same server. When images are copied, Amaya will automatically update all SRC attributes to point new image locations. New locations will be relative URLs.
• The Transform URLs toggle transforms all current URLs into relative URLs when it's possible. Of course, if the document is saved in a local file and URLs point to remote files, URLs will be absolute ones. This ensures that all the links in the document remain correct after the copy. However if you have several document linked together with relative URLs and that you plan to move them to a remote location, disabling URL conversion is needed to avoid referencing the initial locations.
• The Document location field indicates the location where the HTML file has to be written. This can be a file in the local filesystem (e.g. "/pub/html/welcome.html") or the name of a remote URL (e.g. "http://www.w3.org/pub/WWW/Welcome.html").

  Note that this should be a complete path, there is no way actually to guess what would be the name of "http://www.w3.org/pub/WWW". You should also make sure that you have the right to do a PUT method in the case of a remote location. See the page on configuring your server to accept the PUT method or ask your Web administrator.

• The Images location field allows you to save images (if Copy Images has been selected) to a different place than the HTML file. This field should contain the name of a directory in the local filesystem or a location in the remote server.
  • using a relative path, the images is stored at a location relative to the document directory. For example, if the document location is "http://www.w3.org/pub/WWW/Welcome.html" and the images location is "Images", an image "W3C.png" contained in the document is stored at the URL "http://www.w3.org/pub/WWW/Images/W3C.png" and the HTML file is modified to reference it as:

    <IMG SRC="Images/W3C.png">

    This is similar in the case of a document location in the local filesystem.

  • using an absolute path, the images are stored at this exact location, independently of the document location. In the previous example, if the images location specified is "http://pub/WWW/Images", the image is stored at "http://www.w3.org/pub/WWW/Images/W3C.png" and the corresponding HTML file is modified in the following way:

    <IMG SRC="Images/W3C.png">

• Clicking on OK starts the process of transforming the document and a popup asks for confirmation in both cases:
  1. the document has to be saved on a remote server, it shows all the URL to be written to.
  2. the document has to be saved locally and the file already exists.

  Notes :

  • When saving to a remote location please check that the http_proxy is not set, or that the proxy server and the target server are configured to work with the PUT method.

  • Amaya does not currently contact the remote server (in case of an "http://..." destination) to check whether such a document already exists.

Saving documents as text

The Save As command from the Edit menu displays a dialog box that allows you to save the current document in various formats. Clicking the Text button from the Output Format menu saves the document in text form, in a local file. A list of all URLs used in the document is appended to that file.

 

---

14. Spell checking

[SpellChecking.html]

Amaya provides a multilingual spell checker. This tool is invoked by the Spell Check command from the Edit menu. It uses the LANG attribute to select the right dictionary. You can associate this attribute with any element in a document, even with a single word. Use the Language command in the Attributes menu for that purpose.

When the user wants to register a new word, the spell checker creates or updates the "user's personal dictionary". By default, the "user's personal dictionary" is $HOME/.thot.DIC, but the user can define another file. Before starting Amaya, the user must set the parameter "EXTENDDICT=" in the registry file ($HOME/.thotrc file) to change the default name . Thus, the checker will use, in addition to the dictionary specific to the language, this dictionary (in read-write mode) to control all documents.This dictionary is created and automatically updated by the spelling checker when the commands ``Skip (+dic)'' and ``Replace (+dic)'' are issued (see below).

The Spell Check command in Edit menu displays a form which enables you to choose the correction parameters and to interact with the checker:

• The maximum number of proposals is specified in the Number of proposals area. This number can take any value between 1 and 10, the default value is 3. Once an error has been detected, any change made to this value immediately displays a new list of proposals.
• Several buttons in Ignore submenu allow you to ignore certain words: for example words that contain capital letters, digits, Roman numerals or special characters indicated in the list below. This list can be modified by the user.
• The Checking submenu, similar to that in the Search form, allows you to specify the part of document on which the checker will work.
• The erroneous word is displayed in the area Spell checking.... The list of proposals is displayed in the selector located below the incorrect word. By default, the first proposal of correction is selected. To select another proposal, simply click on it. The selected proposal is displayed below the selector. This proposal can be directly modified in the form. The correction is made once you have clicked on one of the buttons Replace and next or Replace (+dic).
• The language in which the correction is made is specified in the top left corner of the form. To change the language, just apply an attribute Language to the text concerned by using the Attributes menu and restart the correction procedure.

To start the correction, click on the Skip and next button bottom of the form. If an error has been found, the incorrect word is selected and highlighted in the document. If no error has been detected, the "Not found" message is displayed in the bottom right corner of the form.

The user can then use one of the buttons placed at the bottom of the form to perform one of the following operations:

• Done: the form disappears and checking is aborted. Previous corrections are not canceled.
• Skip and next: the word considered incorrect is acceptable. No change is made in the text nor in the dictionaries. The checker searches for the next error.
• Skip (+dic): it is the same as ``Skip and next'' but the word considered incorrect is added to the spelling dictionary specific to the document, thus the checker will ignore any subsequent occurrence of this word.
• Replace and next: the word considered as erroneous is replaced by the correct word (changed or modified by the user, see above) and the checker searches for the next error.

• Replace (+dic): it is the same as.Replace and next: except that the replacement word is added to the document dictionary.

 

---

15. Section numbering

[Numbering.html]

Section headings (Hn elements) can be automatically numbered to reflect the document structure. Element H1 is supposed to be the document title and is not numbered, but, when this function is on, all other headings (H2 to H6) receive a number that is computed according to their type and their position in the document structure. These numbers are displayed in blue and cannot be edited directly, but they are updated automatically whenever a heading is created or deleted. They appear not only in the main view, but also in the Table of contents view.

When the document is printed, section numbers appear in the printed document only if the numbering function is on at that time.

When the document is saved, section numbers are not saved in the HTML form, but they are generated in the text form.

The Section Numbering command from the Special menu is a toggle that allows you to switch the numbering function on or off.

 

---

16. Assembling large document collections

[MakeBook.html]

Amaya allows you to handle document collections. Such a collection may, for instance, represent a technical documentation constituted by several web pages. One of these pages contains the title of the whole documentation (an H1 element), an introduction (some other elements), and a list (OL or UL) whose items contain links to each chapter. Chapters are separate documents which can also have the same type of structure.

Such an organization is useful for browsing, but it has a number of drawbacks when the whole documentation has to be printed. Amaya addresses this problem with the "make book" function. You just have to use typed links for linking chapters: associate a rel="chapter" or rel="subdocument" attribute with the anchor that refers to a chapter (select the A element and use the Attributes menu).

Each referred chapter or sub-document can be:

• either a whole external document,
• or just a subset of a larger external document.

To refer to a document subset, the usual manner is to define a DIV element. which delimits the part of the target document you want to include and to link to this target element.

Then, when activating the "make book" function, all blocks (LI elements in the above example) containing a typed link to a chapter will be replaced by the corresponding actual web pages (or web page subsets), and you will get a unique document containing the whole collection:

• when the link refers to a web page, all the BODY content of the target document is included.

• if the link refers to a target element, this element with its content is included.

• if the link refers to a target anchor, the content of the anchor is included, but not the anchor itself.

Before each replacement, the "make book" function generates a new DIV element with an ID attribute. So each added pieces are clearly separated.

Previous pieces of the new generated document could contain normal links, target anchors and target elements. During this operation, Amaya needs to check that each NAME and ID attribute values are still unique in the new document. If needed, Amaya change this values and update relative links. At the same time, external links are automatically updated when they referred an external document or document subset which is included now. For example, if the link pointed to a whole external document, this link will refer the DIV enclosing element after the operation. So the new unique document containing the whole collection is still coherent.

This large document can then be numbered and printed with a complete table of contents and a list of all links.

To activate this tool, choose the Make Book item from the Special menu.

 

---

17. Printing documents

[Printing.html]

To print a document, choose Print from the File menu or click on the corresponding button. Before executing that command, you may need to set some parameters with the Setup and Print command from the File menu.

The Setup and Print command allows you to print only the document, or the document with its table of contents, and/or its table of links.

The Numbered Links option prints a number after each link in the document and generates a table where these link numbers are associated with the corresponding URL.

 

---

A. Configuring Amaya

[Irène Vatton, 1998/03/25 15:10:36, Configure.html]

Amaya uses different configuration files to get initial values for global parameters, dialogue strings, shortcuts, windows size and windows position, user CSS. You can change the default values by creating or updating the following configuration files:

• The registry file $HOME/.thotrc (Unix) or Thot/config/thot.rc (Windows)

  This file is used to define global parameters of Thot applications (Amaya is a Thot application). Inside this file, there's a section called [amaya] where the configuration options are specified for the default home page, proxies, network timeouts, network cache, multi-key support, double-click delay, default colors, default zoom-factor, color palette, dialogue language, personal dictionary, and default printer command.

• The keyboard file $HOME/amaya.keyboard (this file is specific to a Unix user) or Thot/config/amaya.keyboard (this file is the default for Unix users). or Thot/config/amaya.kb (this file is the default for Windows users).

  This file defines Amaya keyboard shortcuts.

• The HTML configuration file $HOME/HTML.conf (this file is specific to a Unix user) or Thot/amaya/HTML.conf (this file is the default for Unix or Windows users). This file defines the position and the size of Amaya document windows.
• File $HOME/.amaya.css (Unix) or Thot/amaya/amaya.css (Windows) contains the user's style sheet.

N.B. These configuration files are loaded at runtime. If you change them, you'll need to quit and restart Amaya to take them into account.

Home Page

You can change the default home page of Amaya by editing the HOME_PAGE variable in the registry file.

Specifying the proxies

You can specify a proxy and a set of domains which should be access without a proxy by means of two proxy variables. You can set up the proxy variables by using either the registry file or your shell's environment variables.

If you use the registry file, find the [amaya], section and specify the proxy variables as in the following example:

HTTP_PROXY=http://groucho.marx.edu:1028
     proxy FQDN --^               ^---- optional proxy port

NO_PROXY=harpo.marx.edu zeppo.marx.edu chico.marx.edu
    FQDN --^           ^--- space separated entries

Amaya uses the environment variables proxy and no_proxy for setting up the proxies. For example, under the UNIX tcsh shell, you can set them up as follows (the syntax is the same as for the registry file):

setenv http_proxy http://groucho.marx.edu:1028
setenv no_proxy harpo.marx.edu zeppo.marx.edu chico.marx.edu

One way to do this under Windows is to add the following lines to your autoexec.bat file:

set http_proxy=http://groucho.marx.edu:1028
set no_proxy=harpo.marx.edu zeppo.marx.edu chico.marx.edu

Please consult your system's documentation for more complete information on how to specify environment variables.

Network timeouts

Starting from version 1.3b, you can customize different network timeouts by means of the following registry file directives:

DNS_TIMEOUT [in seconds, default 60 s]

Timeout while consulting a domain name server

PERSIST_CX_TIMEOUT [in seconds, default 60 s]

Timeout before closing an idle persistent connection (keep-alive)

NET_EVENT_TIMEOUT [in milliseconds, default 60000 ms, use -1 to supress the timeout]

Timeout while waiting for a network event (e.g., while opening a connection)

Cache

As of version 1.3a, Amaya provides a cache thru libwww. The cache is enabled by default and is stored in a directory which is called libwww-cache.

Three registry files entries allow you to control the cache:

USE_CACHE [YES/NO, default YES]

Activates or desactivates the cache

CACHE_SIZE [size in megabytes, default 5 megabytes]

Gives the size of the cache repository

CACHE_DIR [path, the default is the .amaya temporary directory]

The directory path where you want to create the libwww-cache directory

CACHE_PROTECTED_DOCS [yes/no, default no]

By default, documents which are protected by a password aren't stored in the cache. You can change the behavior by setting the value of this keyword to yes.

To purge the cache, you just need to erase the libwww-cache directory (when Amaya is not running), or use the Purge Cache entry in the Special menu.

Document Windows

Parameters related to the particular schema HTML are stored in the HTML.conf file. In that file there are different sections, one by Presentation Schema, that allows user to control position and size of document windows defined by the presentation schema:

• Each presentation schema name is introduced by the keyword style.
• The keyword open declares the main view of the document. It's always the "Formatted-view" for HTML documents.
• The keyword geometry declares other available views.

For each view, in both the open and geometry sections, there is a list of four parameters specifying the x_position, the y_position, the width, and the height of that view. The value of the x_position and the y_position are automatically incremented by Amaya to display diffent document views at different places on the screen.

Default Colors

User interface colors have default values that can be modified in the registry file of the user. The following parameters are used:

• BackgroundColor, the background color of document windows.
• DocSelectColor, the background color of the selected part and of the insertion cursor.

  N.B. The default value for Black and White screens is Black. If you can't see a selection in your screen, change this value to White.

• ForegroundColor, the default color of text in documents.
• MenuBgColor, the background color of: menu bars at the top of windows, the area where the selection message is displayed at the top of document windows, menus, dialogue boxes.
• ButtonColor, background color of buttons in dialogue forms.
• ScrollColor= color of the scrolling bars.

To take into account any change to these options, you need to restart Amaya.

Default Zoom-factor

It's now possible to zoom in and zoom out document window by document window, so each document displayed within a zoomed window will be displayed larger or smaller than its real size according of the current zoom.

Amaya has a default zoom value equal to 0 (documents are displayed by default as they are). This default value can be modified in the registry file of the user by seeting a value to the parameter ZOOM. Users who used the CSS rule "Magnification: 3" in previous Amaya releases (before 1.3) have now to set the corresponding parameter value in the registry file: ZOOM=3.

Colors Palette

CSS allows the user to color documents with one of the 152 predefined colors. During initialization, the editor loads its color table to present them in a palette. If you have problems with your color resources, you can reduce by half the number of colors loaded by the editor by editing the following option in the registry file:

• ReduceColor= yes

To take into account any changes to this option, you need to restart Amaya.

Dialogue Language

The dialogue language is defined by the variable LANG in the registry file. The default language is English (value en_US). At the moment, only two languages are available: English (en) and French (fr). When launched, Amaya loads dialogue files according to the current dialogue language: en- files or fr- files. These dialogue files are located in the directory Thot/config.

In Thot, a document is specified according to a schema. In Amaya, the dialogue message that are displayed when parsing a document or when saving it under a specific schema are given in the Thot/amaya/HTML.code file, where the code suffix is a language abbreviation (e.g., en or fr). This file has 4 sections:

• extension: not used by Amaya
• presentation: not used by Amaya
• export: give the text displayed for each translation schema ("Save As" command)
• translation: give the text displayed for each element and attribute in the Thot HTML structure.

It's possible to adapt Amaya to new ISO-Latin-1 languages by writing corresponding dialogue files. These dialogue files have to be located in the same directory Thot/config, and must use the right ISO 639 code as a prefix (it- for Italian, de- for German, etc.). The specific HTML.code file also has to be created.

Personnal dictionary

Amaya provides a multilingual spell checker. By default the spell checker works with two dictionaries: the English dictionary and the French dictionary (these two dictionaries can be downloaded from W3C servers). When the user wants to register a new word, the spell checker creates or updates the "user's personal dictionary". By default, this "user's personal dictionary" is $HOME/.thot.DIC, but the user can define another file. This other dictionary file path is defined by the parameter "EXTENDDICT=" in the registry file.

By default the "user's personal dictionary" is registered within the file $HOME/.amaya/.thot.DIC, but the user can change its file name by setting a different name value in registry file .

Printer command

The standard printer command is defined by the THOTPRINTER registry file variable. If this command is not well adapted of the current system, the user have to update it before printing using the "Print Setup" command or change this variable in the registry file.

Multi-key Support

The optional input method (Multi-Key) is based on a two key sequence beginning with the "accent" followed by the "letter". For example to obtain a 'ã' first press '~' then type 'a'. To obtain a '~' you have to press '~' twice. The table below gives available key sequences:

accent-letter	~	`	'	"	*	^
a A	ã Ã	à À	á Á	ä Ä	å Å	â Â
c C		ç Ç
e E		è È	é É	ë Ë		ê Ê
i I		ì Ì	í Í	ï Ï		î Î
n N	ñ Ñ
o O	õ Õ	ò Ò	ó Ó	ö Ö	ø Ø	ô Ô
u U		ù Ù	ú Ú	ü Ü		û Û
y Y		Ý	ý Ý	ÿ

By default, this input method is disabled. To active it the user has to edit his/her registry file $HOME/.thotrc (Unix) or Thot/config/thot.rc (Windows) to set the parameter value "ENABLE_MULTIKEY=yes".

Double-click delay

On Unix platforms only, the variable DOUBLECLICKDELAY of the registry $HOME/.thotrc allows one to control the delay under which two mouse clicks are classed as a double-click. The syntax of this variable is:

DOUBLECLICKDELAY [value in milliseconds, default 500 ms]

Keyboard Shortcuts

It is useful to be able to invoke menu commands directly from the keyboard. The Thot toolkit provides a facility that let user accomplish this by means of an application keyboard shortcuts file. This file defines a list of associations between a keyboard sequence an the invoked corresponding command.

The syntax used to define an association is:

 Directive = KeySeq ':' IdentCommand ;
 KeysSeq = KeySet [ ',' KeySet ] ;
 KeySet = [ Modifier ] [ 'Shift' ] Key ;
 Key = '<Key>' KeyValue / '<Key>' SpecialKey ;
 Modifier = 'Ctrl' / 'Alt' / 'Meta' ;
 KeyValue = 'a' / 'b' / ... ;
 SpecialKey = 'Escape' / 'Delete' / 'Space' / 'BackSpace' / 
              'Return' / 'Up' / 'Down' / 'Left' / 'Right' / 
              'Home' / 'End' / 'F1' / ... / 'L1' / ... / 'R1' / ... ;
 IdentCommand = 'TtcInsertChar(' Char ')' / NAME '()' ;
 Char = KeyValue / OctalValue ;  OctalValue = '\' NUMBER ; 

For an example, see the standard amaya.keyboard file, which is located in the config directory.

The list of available commands is:

• Moving commands:
  • TtcNextChar, TtcPreviousChar: move chararcter by character.
  • TtcNextLine, TtcPreviousLine, TtcStartOfLine, TtcEndOfLine: move line by line.
  • TtcNextElement, TtcPreviousElement, TtcChildElement, TtcParentElement: move element by element.
  • TtcPageDown, TtcPageUp, TtcPageTop, TtcPageEnd: move page to page.
• In File menu:

  New, OpenDoc, OpenDocInNewWindow, Reload, SaveDocument, SaveDocumentAs, TtcPrint, TtcPrintSetUp, TtcCloseDocument, AmayaClose

• In Edit menu:

  TtcCutSelection, TtcCopySelection, TtcPaste, TtcDeleteSelection, TtcSearchText, EnSpellCheck, FrSpellCheck.

• In Structure Types menu:

  CreateIsIndex, CreateBase, CreateMeta, CreateLinkInHead, CreateComment.

• In Types menu:

  CreateParagraph, CreateImage, CreateHeading1, CreateHeading2, CreateHeading3, CreateHeading4, CreateHeading5, CreateHeading6, CreateList, CreateNumberedList, ThotCreateMenu, ThotCreateDirectory, CreateDefinitionList, CreateDefinitionTerm, CreateDefinitionDef, CreateHorizontalRule, CreateBlockQuote, CreatePreformatted, CreateAddress, CreateToggle, CreateRadio, CreateOption, CreateTextInput, CreateTextArea, CreateSubmit, CreateReset, CreateAreaRect, CreateAreaCircle, CreateAreaPoly, CreateDivision, CreateNOSCRIPT, CreateObject, CreateParameter, CreateIFrame, CreateInlineMath, CreateMath, CreateMROOT, CreateMSQRT, CreateMFRAC, CreateMSUBSUP, CreateMSUB, CreateMSUP, CreateMUNDEROVER, CreateMUNDER, CreateMOVER, CreateMROW, CreateMMULTISCRIPTS, CreateMTABLE., CreateTable, CreateCaption, CreateTHead, CreateTBody, CreateTFoot, CreateRow, CreateDataCell, CreateHeadingCell, DeleteColumn.

• In Links menu:

  CreateLink, CreateTarget, ChangeLink, DeleteAnchor.

• In Views menu:

  TtcSwitchButtonBar, TtcSwitchCommands, ShowMapAreas, ShowTargets, ZoomIn, ZoomOut, ShowStructure, ShowAlternate, ShowLinks, ShowToC.

• In Style menu:

  TtcChangeCharacters, TtcChangeColors, TtcChangeFormat, ChangeBackgroundImage, CreateClass, ApplyClass, InitCSSDialog, CreateElemEmphasis, CreateElemStrong, CreateElemCite, CreateElemDefinition, CreateElemCode, CreateElemVariable, CreateElemSample, CreateElemKeyboard, CreateElemAbbr, CreateElemAcronym, CreateElemINS, CreateElemDEL, CreateElemItalic, CreateElemBold, CreateElemTeletype, CreateElemBig, CreateElemSmall, CreateSub, CreateSup, CreateQuotation, CreateBDO.

• In Special menu:

  SectionNumbering, MakeBook, CleanCache.

• In Help menu:

  HelpAmaya, HelpBrowsing, HelpSelecting, HelpSearching, HelpViews, HelpCreating, HelpLinks, HelpChanging, HelpTables, HelpMath, HelpImageMaps, HelpStyleSheets, HelpAttributes, HelpPublishing, HelpPrinting, HelpNumbering, HelpMakeBook, HelpConfigure.

 

---

B. Cascading Style Sheet support in Amaya

[Irène Vatton, 1998/02/06 17:27:27, CSS.html]

This document describes the current state of the Cascading Style Sheet support in Amaya. The implementation is based on the CSS1 proposal. We focussed on providing as many features as possible and offering an easy to use and learn interface. Considering the second point we choosed a "learn by example" approach suitable for users not experienced with style sheets.

This document contains the following sections:

1. Section "Presentation" gives a short overview of the CSS.
2. Section "Interface" details the CSS specific areas of the Amaya interface.
3. Section "Current State" presents the CSS functionnalities that are currently implemented.
4. Section "What's lacking" explains the main points to be improved or added.

Presentation

CSS defines a syntax to describe presentation associated with elements as a set of properties (like colors, fonts, etc.). Associated to properties, a selector restrict the application of these rules to a set of element depending on their type (like H1, or LI), their context (like an EM in a H3) or classes applied to an element. A set of rules defines which properties should be applied when more than one selector match a given element. While this is relatively simple for someone used to handle structured documents, the experience has shown that a new user may have difficulties to modelize a document as a structured entity. This might be a problem when trying to introduce the CSS to a large audience.

Thus, the challenge is to build a tool simple enough so that inexperienced people can use styles when creating HTML pages with Amaya, while retaining all the possibilities of CSS. The interface was also designed to not hide the underlying complexity of the document structure (Structure View) and of the CSS language (CSS rules may be shown), in order to shorten the learning curve to structured presentation design.

One of the strongest features of CSS is the cascading model. Presentation rules can be fetched from different remote files, tied to the document or associated to one specific element in a page. This allows sharing and reuse of sets of rules whilst allowing specific presentation. It allows also the use of an user defined set of rules to accomodate his preferences. We tried to give a complete and simple view of the cascading model, showing separately specific presentation (Structure View), document specific rules (Structure View and CSS dialog box) and all the set of rules associated to the external files referenced by the document. It is possible to manipulate rules in one file but also to move them from one file to another, allowing a user to take presentation rules from a remote server and apply them selectively to his own pages, in the purpose of building a pool of presentation rules.

User interface

We first present the Style interface as provided by the current version of Amaya:

The Amaya menu bar contains a Style menu containing all the actions related to presentation and style manipulation. Entries in that menu are ordered from the most specific to the most generic operations, except the two last ones, which are not related to CSS, but to HTML (Information type and Character element).

• Three entries call dialog boxes that associate presentation with the currently selected elements:
  • Character Style allows one to select font attributes (size, style, family and underline)
  • Colors allows one to choose the foreground and background colors from a palette.
  • Format allows one to set alignment, indentation, justification and linespacing.
  • Background Image allows one to insert a background image and to select the repeat mode.

  All modifications made with these dialog boxes can be viewed immediately in the WYSIWYG view and the Structure view.

• Two entries are related to classes:
  • Create Rule uses the style of the selected element to define a new class with the same. A list of the existing classes is proposed, the type of the current element being the default. This is the first step toward defining CSS rules. Presentation is moved from the selected element to the document header, defining a new CSS rule. All elements of the new class take the new style.
  • Apply class uses one of the existing classes and applies it to the selected elements. These elements are then displayed with the style associated with class chosen.
• The Style sheet item gives access to the current list of downloaded CSS files:

  

Current State

Here, we focus on what is currently supported from the CSS1 proposal:

• Parsing:
  • all the basic:
    • grouping selectors in one rule
    • grouping properties in one rule
    • comments (in external CSS files only)
  • classes and pseudoclasses
  • context sensitive selector
  • standard units
• Cascading order should be fine.
• CSS properties: Everything should be parsed correctly, but the back-end may lack support for some attributes.
  • Text: text-align, text-decoration and text-indent.
  • Fonts: Times, Helvetica and Courrier are available, with various character style and a set of prefefined size (from 6 to 60 points).
  • Box Properties: not supported in this version.

There is support for users preferences which can be provided in $(HOME)/.amaya.css (Unix) or Thot/amaya/amaya.css (Windows).

What's lacking

First, considering the current draft compliance, the main issues for full CSS1 support are:

• The Print command does not currently render presentation defined in style sheets.
• The CSS1 formatting model for border, margins and padding is not yet implemented.
• Pseudo elements are difficult to handle.
• The current implementation is a bit restrictive on colors and fonts.

 

---

C. Use of the file HTML.trans

[by Stéphane Bonhomme, 1997/10/20 15:35:25, Transform.html]

This document is an introduction to the structure transformation mechanism provided by Amaya. It describes the syntax of the transformation language and the way transformations are performed in the editor.

The file amaya/HTML.trans contains the description of available transformations. This file can be edited during an Amaya session. It is dynamically parsed when the transformation procedure is called by the editor. So new transformations can be added during an editing session.

Warning: as the description of transformations may contain tags, do not edit file HTML.trans with Amaya. You can use any text editor.

Syntax of the Amaya transformation language

Comments begin with!and continue until the end of the line.

The file consists of a list of transformation descriptions. Each transformation is described by three parts :

• a name terminated by a colon :
• a source pattern terminated by a semi-colon ;
• and a list of rules between braces { } , each rule terminated by a semi-colon ;

The name appears in the Transform menu and identifies the transformation for the end-user.

The pattern

The pattern describes a specific organization of the elements to be transformed. It acts as a filter over the HTML dtd. The purpose of the pattern is to identify a particular combination of elements to which the transformation can be applied. In a pattern it is possible to express conditions on sequence of tags, on the content of a tag and on the existence and value of attributes.

Formally, a pattern contains HTML tags (possibly with attributes) and some composition operators:

| for choice

, for sibling

+ for sequence

? for option

( ) for grouping nodes

The braces { } define the content of a node.

The symbol * is a token that matches any element type.

It is possible to rename a tag by preceding it with a name followed by a colon :

The tag may have attributes. If no value is given for an attribute, an element is matched if the attribute is present. If a value is specified for the attribute, an element is matched if the attribute is present and have the specified value.

Examples of patterns are given at the end of the document.

The rules

A rule expresses how some elements identified in the pattern are transformed. A rule has two parts separated by the symbol > :

• a source tag or a name defined in the pattern,
• a target tag list, giving the tags to be generated, and the place where they are inserted when transforming the source element.

The target tag list is itself divided into two parts separated by a colon : :

• the generation location path (identifies the place where new tags have to be inserted).
• and the list of tags to be generated.

The generation location path is searched in the leftmost branch of the document tree, starting from the parent of the element matching the highest symbol of the pattern.

In the target tag list, the dot symbol "." is used for descending in the tree structure.

If the special token star * ends the list of tags to be generated, the source element tag is not changed but it can be moved to a different place in the destination.

If the source tag or the name in the left part of a rules is present more than once in the pattern, the rule transforms all the elements matching an occurrence of the tag in the pattern.

Transformation process

When the user invokes the Transform command from the Types menu, the HTML.trans file is parsed. Then the selected elements are matched with the pattern of each transformation. The names of the matched transformations are proposed to the user in a pop-up menu.

If several transformations with the same name match the selected elements, the higher-level matching transformation is proposed to the user. If several transformations match at the same level, the first one declared in the HTML.trans file is proposed. As a consequence it is recommended to specify the transformations with specific patterns before the more general ones.

Once a transformation has been chosen by the user, the destination structure is built according to the rules while selected elements are traversed.

Finally, the contents of the source elements (text and pictures, but also structured elements) are moved into the produced elements.

This transformation process for HTML documents is fully described in Interactively Restructuring HTML Documents, a paper presented at the 5th international WWW conference in Paris, May 96, by Cécile Roisin and Stéphane Bonhomme.

Examples

• The first example merges several consecutive unnumbered lists (UL) into an unique list.

  Merge Lists: (UL{LI+})+;
      { 
      LI > UL:LI; 
      }
  

  The pattern matches a sequence of unnumbered lists (UL), that contain a sequence of items (LI).

  The rule expresses that each time an item is encountered when traversing the matched elements, a new LI tag is created within an UL. When the rule is first applied, the resulting structure is empty, so there is no UL element in which the LI can be created. Therefore an UL is first created, then the rule can be applied.

• The second example transforms a definition list into a table.

  Table: DL{(DT|DD)+}; 
     { 
     DT > <TABLE border=1>.TBODY:TR.TD; 
     DD > <TABLE border=1>.TBODY.TR:TD; 
     }
  

  The pattern matches any Definition List element (DL).

  The rules explain how the table is incrementally built when the structure of the selected definition list is traversed :

  • Each DT involves the creation of a new row (TR) in the table body.
  • Each DD involves the creation of a new cell (TD) in the last existing row of the table.

• The third example removes a table element, keeping its content unchanged but extracted from the table.

  Remove Table:
  TABLE{?CAPTION,?(body:*{(TR{(TD{(?cell_content:*)+}|
                               TH{(?cell_content:*)+}
                             )})+})+};
       { 
       CAPTION>H3; 
       cell_content>:*;
       }
  

  The pattern matches any table and identifies the content of each cell of the table (cell_content).

  The second rule expresses that the contents of each cell have to be moved to the place of the original table.

• see the file amaya/HTML.trans for more transformation examples.

 

---

D. Plug-ins Support in Amaya

[Ramzi Guetari, 1997/10/23 14:11:53, Plugins.html]

Plug-ins allow Amaya to be extended by embedding external application. Two main motivations lead us to add a support for plug-ins into Amaya:

• To make new experiments with HTML Cougar especially with the OBJECT element,,

• To allow users to use new image formats, to support audio/video applications, to run some new web applications such as control applications (electronic payment for example), etc.

Amaya Plug-ins support is developed according to the Netscape Plug-in API.

Usage of Plug-ins

There is no difficulty for installing plug-ins for Amaya. One just have to create a plug-in directory, in which the dynamic code of plug-ins have to be stpred, and to define the environment variable AMAYA_PLUGIN_DIR that gives the plug-in directory. For example:

> mkdir /users/guetari/plugindir

> setenv AMAYA_PLUGIN_DIR /users/guetari/plugindir

If the environment variable AMAYA_PLUGIN_DIR does not exist, Amaya uses the default directory $(HOME)/.amaya/plugins to look for dynamic code of plug-ins when it starts up.

Some other files may need to be installed and/or other environment variables have to be set (according to plug-ins installation instructions).

At the present time, plug-ins are developed for commercial web browser and may have assisted automatic installation procedures. These latter are not yet valid for Amaya, only manual installation is right.

The plug-in button when pressed shows the list of all installed plug-ins. For each of them we can see the Mime type it handles.

There is a major difference between Amaya and other web browsers supporting plug-ins mechanism. Plug-ins are encapsulated in HTML pages using the OBJECT element and not the EMBED element which is not recognized in ani W3C HTML DTD. OBJECT is a part of the HTML Cougar norm.

At least three parameters are required for each plug-in:

• DATA which is a URL to the object's (plug-in) data,

• WIDTH which gives the suggested width of a box enclosing the visible area of the object (plug-in),

• HEIGHT which gives the suggested height of a box enclosing the visible area of the object (plug-in)

<OBJECT DATA="http://www.location/plugindatadir/datafile.ext" HEIGHT=400, WIDTH=200>

</OBJECT>

In addition to these three parameters, plug-ins may need other attributes to communicate information between the HTML page and its code. These private attributes have to be introduced using the PARAM element of the OBJECT element.

Amaya Plug-in API

When Amaya starts up, it looks for all available plug-ins into the amaya plug-in directory. For each plug-in, it initializes a structure (PluginInfo) which indicates the path and the name of the dynamic code of the plug-in, its mime type, its identifier, and the functions supplied by Amaya. These functions allow the plug-in to communicate with Amaya:

struct PluginInfo {

   char* pluginDL;       /* Location of the plug-in dynamic code */

   char* pluginMimeType; /*Mime type of the plug-in */

   char* pluginID;       /* plug-in identifier */

   char* pluginURL;      /* Where data needed by plug-in is stored */

   char* fileExt;        /* Suffix of files supported by the plug-in */

   void* pluginHandle ;  /* Address of the dynamic code of the plug-in when loaded */

   NPPluginFuncs* pluginFunctionTable; /* Functions supplied by the plug-in */

};

For each plug-in a driver is added into the PictureHandlerTable. It indicates the coordinates, the height and the width of the box where the visible part of the plug-in will be displayed, the name of the data file needed by the plug-in, the pointer on the instance of the plug-in when created. An instance of a given plug-in is created when Amaya encounters in a HTML file data of a Mime type registered for the plug-in.

TtaBrowsePluginDirectory:

This function browses the amaya plug-in directory mentioned by the environment variable AMAYA_PLUGIN_DIR (or the directory $(HOME)/.amaya/plugins by default). For each plug-in, it initializes the structure PluginInfo and store it into the pluginTable. Then it calls the function InitPluginHandlers. TtaBrowsePluginDirectory requires no parameters:

TtaBrowsePluginDirectory ()

InitPluginHandlers:

This function initializes a driver for the plug-in and stores it in the table of the image drivers (PictureHandlerTable). This driver shows the coordinates, the height and the width of the box where the visible part of the plug-in will be displayed, a pointer to an instance of the plug-in, the data file name needed by the plug-in, etc. This function requires two parameters:

InitPluginHandlers (boolean printing, int indexHandler)

• printing is a boolean variable which indicates if the driver supports printing. At the present time, it is always set to FALSE.

• indexHandler is the index of the plug-in in the pluginTable.

Ap_InitializePlugin:

This function loads the dynamic code of the plug-in, determines its Mime type and indicates to the plug-in the functions supplied by Amaya. These functions are needed by the plug-in to communicate with Amaya. This function requires two parameters:

Ap_InitializePlugin (char* path, int indexHandler)

• path indicates the directory of the dynamic code of the plug-in and the name of the library (for example: "/users/guetari/.amaya/plugins/mypluginlib.so")

• indexHandler is the index of the plug-in in the pluginTable.

Creating instances and displaying plug-ins

When Amaya encounters data of a Mime type registered for a given plug-in, it creates an instance of the plug-in, displays it and transmit the data to the plug-in.

Ap_CreatePluginInstance:

This functions creates an instance of the given plug-in and a stream with the data file. Then it calls the plug-in function NPP_NEW. This function requires three parameters:

void Ap_CreatePluginInstance (PictInfo* imageDesc, Display* display, int type)

• imageDesc gives the information about the plug-in: X and Y coordinates, width and height of a box enclosing the visible area of the plug-in, the data file name and a pointer which will be set to the address of the instance,

• display (for unix platforms),

• type allows to determine the index of the plug-in in the pluginTable.

When the instance is created, it interacts with Amaya: Amaya may call plug-in functions and vice versa. The Amaya functions called by the plug-in are:

Ap_MemAlloc:

Allocates memory from Amaya side. It requires one parameters the size of block memory to be allocated.

void* Ap_MemAlloc (uint32 size)

Ap_MemFlush:

At the present time, Ap_MemFlush calls Ap_MemAlloc and does nothing else. It requires one parameter:

void* Ap_MemFlush (uint32 size)

Ap_MemFree:

Deallocate the block of memory specified by ptr. Its parameter is the pointer to deallocate:

void Ap_MemFree (void* ptr).

Ap_DestroyStream:

Closes and deletes a stream. It requires three parameters:

NPError Ap_DestroyStream (NPP instance, NPStream* stream NPError reason)

• instance is the instance of the plug-in concerned by the stream to be destroyed,

• stream is the stream to destroy

• reason indicates why the stream has to be destroyed

Ap_GetJavaEnv:

Not yet implemented

Ap_GetJavaPeer:

Not yet implemented

Ap_URLNotify:

Notifies a plug-in instance of the completion of a URL request. It requires four parameters:

void Ap_URLNotify (NPP instance, const char* url, NPReason reason, void* notifyData)

• url is the location of the data needed by the stream,

• reason is the reason of the notification: the data is completely transmitted, the stop button is pushed, etc.

• notifyData is a plug-in private value used to uniquely identify the request.

Ap_GetURL:

Requests that a new stream be created with the contents of the given URL. It requires three parameters:

NPError Ap_GetURL (NPP instance instance, const char* url, const char* target)

• instance is the plug-in instance which require the creation of the new stream,

• url is the location of the data needed by the created stream,

• target indicates the target of the stream. If target is non-NULL, the stream is sent to Amaya, otherwise, the stream is sent to the plug-in.

Ap_GetURLNotify:

Does the same thing then Ap_GetURL but notifies to the plug-in the end of the stream by calling Ap_GetURLNotify. It requires a parameters more than Ap_GetURL which is notifyData. This latter is a plug-in private value used to uniquely identify the request.

NPError Ap_GetURLNotify (NPP instance instance, const char* url, const char* target, void* notifyData)

Ap_NewStream:

Requests the creation of a new stream of data produced by the plug-in and consumed by Amaya. This function is, at the present time partially implemented into Amaya. It requires four parameters:

Ap_NewStream (NPP instance, NPMIMEType type, const char* target, NPStream** stream_ptr)

• type is the mime type of the stream to be created,

• target indicates the window or the frame where the result of the stream will be displayed,

• stream_ptr is a pointer on the stream which will be created.

Ap_PostURL:

Post data from a file to a given URL. This function is partially implemented at the present time and requires six parameters:

Ap_PostURL (NPP instance, const char* url, const char* target, uint32 len, const char* buf, NPBool file)

• buf contains the data to be posted,

• len is the length of the buffer to be posted,

• file is a boolean. If it is TRUE, the data is stored in a file else it is stored in a bloc memory.

Ap_PostURLNotify:

It behaves exactly like Ap_PostURL but notifies the plug-in at the end of the post operation (by calling Ap_URLNotify). In addition to the parameters of Ap_PostURL, it requires a parameter of type void* which is plug-in private value used to uniquely identify the request (notifyData).

Ap_PostURL (NPP instance, const char* url, const char* target, uint32 len, const char* buf, NPBool file, void* notifyData)

Ap_RequestRead:

Request a range of bytes for a seekable stream. It requires two parameters a stream and list of types NPByteRange which is a linked list of objects, each of which indicates an offset and a length into the stream:

NPError Ap_RequestRead (NPStream* stream, NPByteRange list)

Ap_GetValue:

Only for Unix platform. It requires three parameters: instance (of the plug-in), variable (of type NPNVariable) and r_value (of type void*). instance and variable are input parameters and r_value is an output parameter. If variable is set to NPNVxDisplay, r_value is set to the value of the Display. If variable value is NPNVxtAppContext, r_value is set to the value of the application context.

void Ap_GetValue (NPP instance, NPNVariable var, void* r_value)

Examples of plugins

• Try the tcl plug-in here

• Here you can play with the webxpresso plug-in

• Examples of vosaic plug-in are here

 

---

E. The Amaya Architecture

[V. Quint, 1997/09/18 14:36:54, AmayaArchi.html]

Abstract

Amaya is a large piece of software. If you want to change it or extend it in some way, you may experiment some difficulty in finding out the right part to be modified in the code. The purpose of this note is to help you understand the Amaya architecture and find your way in the source code.

Contents

1 Architecture

1.1 Document representations

1.2 Software components

2 Changing and extending Amaya

2.1 Changing menu bars and pull-down menus

2.2 Changing the button bar

2.3 Changing default document presentation

2.4 Creating new views

2.5 Adding new HTML tags and attributes

2.6 Modifying existing commands

2.7 Creating new editing commands

2.8 Adding new structure transformations

2.9 Configuring Amaya

1 Architecture

Amaya is an application based on Thot. Thot is a generic tool kit intended to build document based applications, with a structured approach to the document model. Basically, Thot provides a set of document manipulations functions with an API and allows applications to include additional functions through a callback mechanism. It also includes a simple declarative language to generate the user interface of an application.

1.1 Document representations

Different document representations are maintained or generated by Amaya:

Document structure and contents

Each document is represented by a tree within Amaya. This tree represents the document structure. Its leaves contain the actual text. You can see a visual representation of that tree in the Structure view. This tree structure is constrained by some rules that are specified in a Thot structure schema (file HTML.S in directory amaya), written in the S language (see the language manual).

Names of element types and attributes in file HTML.S are not those that the user actually sees on the screen. Correspondence between internal and external names is given by file HTML.en in directory amaya.

Document presentation and views

The internal tree structure only represents the logical structure of HTML documents. The graphical aspect of these documents is specified by a Thot presentation schema (file HTMLP.P in directory amaya), written in the P language (see the language manual).

The presentation schema specifies all possible views of HTML documents and the aspect of these documents in each view. It also specify how documents should be formatted for printing.

Amaya uses a single source file (HTMLP.P) to specify different presentation schemas, using conditional compilation (see variables PAGE, BLACK_WHITE, US_PAPER).

HTML output

While editing, Amaya works on the internal tree structure. HTML files are produced only when saving a document. Then, the tree structure is written in the output file according to a Thot translation schema (file HTMLT.T in directory amaya), written in the T language (see the language manual).

1.2 Software components

The main software components involved in Amaya are the following:

Graphical user interface

The Amaya user interface contains three types of widgets:

• A menu bar, at the top of each document window

  This bar and all its menus, including cascading menus, are specified in a Thot application schema (file EDITOR.A in directory amaya) written in the A language (see the A language manual).

• A button bar below the menu bar, in the formatted view.

  This button bar is created by Amaya at initialization time (see function InitDocView in module amaya/init.c).

• Various dialogue boxes

  Some of these dialogue boxes are standard Thot dialogue boxes, other are created by the Amaya application. Both Thot and Amaya use the Thot dialogue module.

Standard Thot editing functions

A number of basic editing functions are simply standard Thot functions. The name of these functions start with Ttc.

Specific editing functions

In addition to the standard functions, Amaya has its own editing functions.

• Some functions are called from the menu bar (see file EDITOR.A in directory amaya) and are implemented in the C modules of directory amaya.
• Some functions are called from the button bar (see function InitDocView in module amaya/init.c) and are also implemented in the C modules of directory amaya.
• Some functions are called from standard Thot editing commands. They are defined in file HTML.A (directory amaya) and implemented in the C modules of directory amaya. They implement some specific treatments that are required for tables, pictures, forms, style sheets, etc.

HTML Parsing

HTML files are parsed by module html2thot.c (directory amaya), which builds the internal tree structure.

CSS parsing

Style sheets and CSS syntax in general are parsed by module HTMLstyle.c.

Structure transformation

Structure transformation commands are handled by two modules: trans.c and transparse.c. These modules are driven by the HTML.trans file (directory amaya), which specifies the possible transformations.

2 Changing and extending Amaya

A number of modifications to Amaya can be made without modifying the C code. As explained above, the behavior of Amaya is defined by a number of schemas and other files that can be modified easily, as they are written in very simple declarative languages. Prior to making any change to the source code, it's worth considering modifications to these files.

2.1 Changing menu bars and pull-down menus

You may want to change the user interface. The simplest change you can make is modifying the menu bars and the pull-down menus.

There is a menu bar on top of each window handled by Amaya. Notice that the contents of these menu bars vary according to the view displayed in the window.

All menu bars and the corresponding pull-down menus are defined in file EDITOR.A (directory amaya). Update that file for defining your own menu bars (it is written in the A language, which is documented in The Thot Application Generation Language). Then, you just have to make amaya.

If you want the new (or existing) menus and their items to be available in different languages, don't forget to update the xx-amayadialogue file (in directory config), where xx is the language name (for instance, en for English or fr for French).

2.2 Changing the button bar

You can change the button bar of the formatted view in many ways. You can

• remove buttons (most of them are equivalent to some menu item),
• change their order,
• change their icon,
• add new buttons.

For all these changes, you have to edit the function InitDocView in module amaya/init.c and to make amaya.

2.3 Changing default document presentation

Document style can be changed in many ways. In a document, stylistic information can be associated with a given element, with all elements of a given type, with all elements having the same class attribute, etc. You can do that with the Style menu (refer to the user's manual), but you may want to change the default presentation of all documents displayed by Amaya. There are two ways to do that:

Using a personal style sheet

Create a file .amaya.css in your home directory or edit it if it exists. This file is written in the CSS1 language.

When the file is updated you don't need to do anything else. The next document you load or reload will be displayed with the new style sheet.

These changes only apply to the Formatted view of the documents you display.

Changing the presentation schema used by Amaya

Edit the HTMLP.P presentation schema in directory amaya. This file is written in the P language (see the Thot language manual). By editing this file, you may modify the appearance of all documents in any view.

When the file is updated, you need to compile it with the prs compiler, but typing make amaya in the amaya directory does the job.

Changes made that way apply to all documents displayed or edited by all users sharing the same installation of Amaya, but style sheets supersede the presentation schema.

The presentation schema specifies document presentation on the screen as well as on the paper. To change the layout of printed documents, including page headers and footers, with numbers, running headings, etc., focus on the parts that follow conditions #ifdef PAGE in the schema.

2.4 Creating new views

You may create new views by editing and compiling file HTMLP.P (see above), but this is not enough. You must also edit file EDITOR.A to add a new item to the Views menu (see above). This item is associated with a C function that you must create in file init.c. You can use functions ShowStructure and ShowAlternate as examples.

You may specify the default position and size of the view in file HTML.conf.

Just make amaya when all these changes have been made.

2.5 Adding new HTML tags and attribute

To experiment an HTML extension, you must update several files:

HTML.S

Declare the new element type or attribute in the structure schema HTML.S. If you want the external name of the new element or attribute to be different in different languages, update the files HTML.xx, where xx is the name of the language.

HTMLP.P

Specify the default presentation of the new element or attribute in the presentation schema HTMLP.P. Don't forget to specify the presentation in all views. For the Structure view, some new presentation boxes will probably be needed.

HTMLT.T

Specify the corresponding HTML syntax in the translation schema HTMLT.T.

EDITOR.A

If it's a new element, add an item to the Types menu or to one of its submenus, to allow the user to create these elements. The new menu item will call a function that you must also write. This function is very simple in most cases (refer to functions corresponding to existing menu items in module EDITORactions.c).

If it's an attribute, the Attributes menu will be updated automatically.

html2thot.c

To allow Amaya to parse the new tag or attribute, you must update the HTML parser. HTML elements and attributes are declared in tables at the beginning of module html2thot.c, as well as the corresponding element or attribute defined in the structure schema HTML.S. In most cases, updating these tables is enough.

If the new element or attribute needs some extension to standard editing commands or some new editing commands, see the next two sections.

2.6 Modifying existing commands

You can modify Thot standard commands or Amaya specific commands.

File HTML.A specifies all extensions and replacements for Thot standard editing commands. You can modify the functions implementing these extensions and replacements. You can also specify additional such functions, by editing file HTML.A and writing the code implementing the new functions.

Amaya specific editing functions are those referred to in file EDITOR.A. They are implemented in the C modules of directory amaya. You can obviously change these implementations.

2.7 Creating new editing commands

To create new commands, you have to define their user interface (add a new menu to a menu bar, a new item to an existing menu and/or a new button to the button bar) and to write the code of the corresponding function.

2.8 Adding new structure transformations

The last item of the Types menu allows you to transform the structure of the selected elements. When activating that item, you get another menu that presents the choice of the possible transformations.

To offer new transformations, you have to specify them in the HTML.trans file (directory amaya). You don't need to do anything else (no compilation, no make). The menu of the possible transformations will be updated automatically, according to the current selection and the new contents of the HTML.trans file.

2.9 Configuring Amaya

Users can configure Amaya in various ways, just by editing some configuration files. This is described in the chapter Configuring Amaya.

 

---

F. Changes in the different versions

[Irène Vatton, 1997/07/10 (?), New.html]

This file indicates the new features you can find in the latest versions of Amaya.

Amaya 2.2

26 October, 1999

New features:

• CSS:
  • Amaya is now able to print with CSS. By default Amaya takes into account style sheets when printing. The entry "Ignore style sheets" allows one to print documents like in previous Amaya version.
  • For a better mapping with CSS, language P has been extended. Style and Weight are now two separate properties. This allows Amaya to handle the corresponding CSS properties (font-style, font-weight) independently and to display text both italic and bold.
• A Source view is now available from the Views menu. When you select in the main view, an index points at the corresponding markup in the source view and conversely. You can edit the source code. Every time you save the source code or you activate the Synchronize entry of the Files menu, the other views are updated to reflect the latest changes.
• Four different Amaya profiles are proposed: editor, mini-editor, browser, mini-browser. Amaya menus and buttons are displayed according to the current profile.
• User Interface:
  • The backspace deletes the current selection when that selection is not empty and delete the previous character in other cases.
  • If there is no selection in the document which receives the current focus and the user hits any arrow key, a selection is automatically generated at the window top.
  • A new option in the Preferences/Publishing menu allows to declare a set of domains where a PUT may be redirected, and thus avoid having a popup asking a user to confirm each redirection.
  • It's now possible to define a shortcut to follow a link or activate a form element (menu, submit, reset): the name of the function is DoAction and the default shortcut is "Alt Return".
  • A new command "Link previous target" allows one to create a link to the latest created target. The default shortcut is "Ctrl Shif L".
• A mechanism of templates allows you to experiment templates provided by the W3C server or to install your own template server. To use the sample W3C template server, open the Special/Preferences/Templates menu and type in the following URL: http://cgi.w3.org/cgi-bin/createform.pl. Quit Amaya and there'll be a new option in the File/New submenu: From template.

Fixed bugs:

• User Interface:
  • It was impossible to cancel the creation of a link. Now the second button in the creation popup is 'Cancel' instead of 'Done', and when that button is pressed, the whole action is cancelled.
  • Improvement of attribute menus.
  • There was a confusion in the button bar.
  • With an extended selection the right arrow and the bottom arrow moved the selection relatively to the beginning of the selection instead of the end.
  • Empty Math boxes were not displayed on Windows platforms.
  • The cancel button didn't always work in the Windows authentication dialogue.
• CSS:
  • When the color was invalid Amaya used the black. Now the CSS rule is ignored.
  • CSS comments within style elements were lost.
  • The CSS parser didn't supported TABs in CSS style sheets or STYLE elements.
  • Amaya misinterpreded complex selectors.
• SGML entites and spaces weren't being handled correctly when saving a document or when browsing a URL.
• Hexadecimal entity references were not recognized by the HTML and XML parsers.
• Relative URLs beginning with a "../../ " path were being simplifed into "../"
• When a Unix user launched Amaya with a not existing local file, Amaya displayed a form to create a new document, but that form didn't work well. If the user opened the document, the File menu was broken. If the user cancelled the form the application wasn't closed.
• When printing, parentheses that are part of mathematical expressions were misplaced on the page.
• Amaya could get stuck when creating an anchor.
• Some memory leaks in the Windows version are fixed. There was a memory leak when the download of a distant image failed.
• Amaya could crash if you had a single document window with pending net requests and you closed it.
• The replace string in the Search/Replace command could be lost.
• The root element HTML supports the attribute lang now.

Known bugs:

• Opening the source view of an HTML document which doesn't have an extension and which includes an image having the same name as that of the document, may result in the opening of the image source, rather than that of the document. Under Windows, this may happen even if the document and the image's names only differ in case.
• Amaya doesn't saves yet the current positions of Windows upon exiting. This will be done in the next release.

Amaya 2.1

24 June, 1999

Extensions 2.1:

• User Interface:
  • The Save item in menu File and the Save button are disabled when the document does not need to be saved.
  • Menu entries Quotation, Subscript, Superscript, and BDO can be set or unset from the "Character element" menu.
  • New colorful button bar
  • New Home button
  • Command File/New has been changed. It now proposes 3 possibilities:
    1. "New HTML document" displays a form to choose the location of the document to be created before it displays a blank page.
    2. "From template" proposes a list of templates to be used for the new document when you have a template server.
    3. "New CSS" displays a form to choose the style sheet location first.
  • Menu Special/Preferences contains a new item for language negotiation.
  • In addition to the color palette in the Special/Preferences/Colors menu, the user may now type in directly the color code (the color palette is only available under Windows).
• Thot API: Due to a conflict with the libjpeg definition the Thot type boolean has been renamed ThotBool.
• MathML: the full presentation part of MathML is now supported, but not all attributes are yet taken into account when formatting mathematical expressions.
• LibWWW:
  • Updated to version 5.2.9.
  • The libwww is now compiled as a number of mini libraries instead of big, monolithic one. We only compile those that are needed for Amaya, thus reducing the compilation time and size of the Amaya executable.
  • The libwww cache entry wasn't being updated when saving a previously cached document.
  • Tagged the libwww CVS base with an "Amaya" tag, showing the reference version currenly being used by the Amaya team.
• New list of Amaya shortcuts for both Windows and Unix platforms.
• User preferences:
  • Changed the behavior of the user and temporary directories under Windows.
  • Stopped using the Windows registry to store state information.
  • The directory where the user preferences are stored is now a fixed one. The user may change the location of the temporary directory as well as that of the cache. Users are advised to reselect their preferences, rather copying their precedent thot.rc file. You may copy your amaya.css, HTML.conf, keyboard.kb, and dictionary.DCT files from your old Amaya home directory to its new location (open the Special/Preferences/General Preferences menu to find where it is). For more information, consult the Help/Configuring Amaya document.

Fixed bugs 2.1:

• Amaya was not able to use the shared library libjpeg.so.
• There were some memory leaks in the previous version.
• CSS parser:
  • CSS comments were lost in the style element.
  • The end of the style element was not detected when it included an unclosed CSS comment.
• Amaya crashed when following a redirection to an invalid URL.
• Amaya could crash after a copy/paste of a mathematical formula from one page to another.
• Sometimes the paste command mixed pasted elements and the cursor jumped.
• It was impossible to set font-size to 20 in the preference menu.
• Amaya didn't take care to the Shift in the keyboard configuration file.
• Improvement of Windows dialogues.
• The libwww cache entry wasn't being updated when saving a previously cached document.

Amaya 2.0

3 May, 1999

Extensions 2.0:

• First implementation of a multi-document, multi-level Undo/Redo command.
• WAI guidelines on Image and Maps.
• COLGROUP and COL elements are accepted and can be created within TABLE elements. The rendering is not implemented yet, though.
• CSS properties "left-margin", "top-margin", and "display: none" are now interpreted.
• Amaya is now able to load, edit, print and save CSS files and plain text files.
• The entry "Style Sheets" in the menu Style allows one to
  • link a CSS file using the standard Amaya paragdim: Click to select the target or display a form allowing us to type the URI. The corresponding LINK element is automatically created and CSS properties are applied to the document.
  • open a CSS file used in a document.
  • open a CSS file used in a document.
  • disable CSS properties of the CSS file.
  • enable or re-apply CSS properties of the CSS file.
  • remove a CSS link.
• After a "Make Book" the document is automatically switched to the Read-Only mode. This will avoid the user to edit it or save it by error.
• Publication thru the net now uses the HTTP/1.1 etags and conditional headers to avoid the lost updates problem..
• The 409 HTTP error message (conflict) is now shown in a popup window.
• Added DEFLATE content encoding support under Windows.
• First support of disconnected browsing mode thru the libwww cache.
• Command SaveAs allows you to save a document in XHTML, following the specifications and guidelines of the latest XHTML draft.
• Adding new menu entries:
  • Back and Forward: navigation commands
  • Editor/Browser mode: setting Amaya mode (read only or read/write)
  • Amaya at W3C: link to the http://www.w3.org/Amaya/User/BinDist.html page from the Help menu.
• Implementing a new policy of colors allocation.
• First version of Preferences configuration menus.
• The Verfiy each PUT with a GET option is now turned off by default
• It's now possible to browse with a simple-click or a double-click. By default Amaya uses the double-click, but it could be switched to simple-click in the General preference menu.
• Using the Publishing preferencesmenu, it's now possible to choose the default name for saving URLs that end in "/".
• New version of the Thot API:
  • Changing of TtaAddButton and TtaChangeButton to merge Windows and Unix dialogue API.
  • New functions: TtaGiveNextElement, TtaGetFirstLeaf, TtaGetLastLeaf
  • A new Thot event: TteElemClick
• All user Amaya preferences and personal files are collected into a home directory. By default this directory is $HOME/.amaya on Unix platforms and C:\TEMP\amaya on Windows platforms. These files are:
  • a personal amaya.css
  • a personal amaya.keyboard (amaya.kb on Windows)
  • a personal dictionary
  • thot.rc personal preferences. This file is generated and updated thru the Special/Preferences menu
  • other temporary files and directories used by Amaya.
• After a paste command, the selection is now set at the end of the pasted text where the user could continue to insert text.
• The Amaya CVS base is now available in read-only mode at http://dev.w3.org/. The Root directory is now Amaya instead of Thot and the libwww is no longer considered as a part of the Amaya code. The source tar file includes the libwww code (libwww is a directory next to Amaya) and one who acceedes the CVS base needs to get the libwww code (cvs get libwww) to compile Amaya.

Fixed bugs 2.0:

• Scripts can now be created within the document Body and are no longer moved into the Head at parsing time.
• When creating a new polyline in an area map there was a bug which generated wrong coords values on Windows platforms.
• Comments in files amaya.keyboard and amaya.kb are now allowed.
• When a document included the sequence <form>..<table>..</form>..</table> Amaya closed the table at the end of the form. Now it reports a parsing error on the end tag </form> and avoids to split the table.
• Copying an image from a remote document to a local document didn't work.
• When following a link which had a "?foo" ending, Amaya treated that ending as a query string.
• Some attributes values appeared with strange names in the Attribute menu.
• When the current position was in a sequence of empty blocks (paragraphs, for instance), the Backspace key deleted two of these blocks at once and did not select anything.
• When pasting a paragraph with an attribute at the beginning of a table cell or list item, it was turned into a pseudo-paragraph, and produced wrong HTML code when the document was saved.
• Amaya locked up when one applied the strong command to a text displayed at the beginning of a line.
• CSS selectors like "PRE SPAN.test" didn't work.
• The CSS parser didn't parse well the rule url("...").
• SMALL elements could be displayed too small.
• <basefont face="...."> was saved as <basefont facee="....">.
• When putting an attribute on a text string, the attribute was generated as text in the HTML output. Now a SPAN element is generated to carry the attribute. This bug occured with attributes title, dir, and most event attributes (onclick, ondblclick, onmousedown, etc.).
• Amaya crashed when loading an isolated image with a filename without a suffix.
• People who compiled Amaya on Windows platforms couldn't display jpeg images. The problem is fixed now.
• The authentication handlers were desactivated while doing a HEAD pre-check during the lost update PUT procedure.
• While browsing an image, pressing the reload button didn't show the image again.
• It wasn't possible to browse images when the request was redirected to a URL having a different end name.

Amaya 1.4 and 1.4a

12 January 1999

New Features:

• Update of the German dialogue files (voluntary work done by Erich Koerting)
• On Unix platforms only, the variable DOUBLECLICKDELAY of the registry $HOME/.thotrc allows one to control the delay (in millisecond) under which two mouse clicks are classed as a double-click. The default value is 500.

• OPTGROUP elements are accepted within SELECT elements. The corresponding cascade menus are built by Amaya and the right string is sent to the server when submitting a form that contains OPTGROUPs. An item in the Types/Form menu allows the user to create OPTGROUP elements or to wrap OPTION elements into an OPTGROUP element.

• Elements FIELDSET and LEGEND from HTML 4.0 (used in forms) are implemented.
• Event attributes like onmousedown, onmousemove, etc. are listed in a sub-menu of the Attributes menu (Events sub-menu).
• When creating a Table, Amaya asks the user about the number of rows and columns s/he wants. When a new cell is created, the corresponding column is generated at the same position.
• When target icons were introduced, it was no longer possible to click the target element (an element with an ID attribute or an anchor with a NAME) to set a link. This possibility is available now.
• When reloading a document, the fresh document is shown in the formatted window at the position the previous version was shown.
• When saving a document in XML, Amaya follows the Voyager guidelines (http://www.w3.org/TR/WD-html-in-xml)
• When printing a document, you can decide whether the document URL is printed at the top of each page or not.
• A new field in the dialogue form used to insert images allows the user to enter an ALT attribute. This attribute is mandatory.
• libwww has been upgraded to version 5.2. This version of libwww supports HTTP/1.1, rev. 05
• A first implementation of the message digest authentication protocol, as defined in <draft-ietf-http-authentication-03>. The code is interoperable with the current (which is an old) implementation of this protocol inside Apache/1.3.
• When Amaya detects errors in a loaded document, it generates a log file which can be displayed by the entry "Show log file" in the menu "Special".
• Thot compilers (str, prs, tra and app) are available on Windows platforms, so it's now possible to develop Amaya on these platforms.
• When an URI points at a single image, Amaya can display this image in a document window.
• Each Amaya window can be switched from Read-Only (editor) to Read-Write (Browser) mode, and vice versa.
• A FAQ is available at http://www.w3.org/Amaya/User/FAQ.html

Fixed bugs:

• There was a memory leak when following an internal link pointing to an inexistent anchor.
• Links which point to non-existent documents or invalid URLs are now left in the "active" state, instead of being set to the "visited" state.
• Browsing an image from an edited document (and thus requiring the opening of a new document window), didn't show the image.
• When one created a table while the current selection pointed to an empty paragraph, Amaya tried to replace the empty paragraph by the table, but there was a bug which corrupted the Amaya internal structure.

• In the menu associated with a <SELECT multiple> element it's now possible to deselect selected OPTIONs

• Table formatting: - Amaya wasn't able to find the correct cell width when the contents of this cell was centered or when a cell included complex structures. - When a table of a given width included constrained and unconstrained cells the result was sometimes incorrect. - When a table with vertical spans was resized, row heights were not updated.
• Amaya constrained the structure and reordered some elements in the HEAD: Meta, Script, Link, Style.
• Command Apply Class did not work always, especially when the current selection was crossing elements at different levels.
• Relative URIs for background images were always interpreted according to the document URI, even when it was relative to a stylesheet.
• A background image in no-repeat mode was sometimes repeated erroneously.
• Amaya tended to raise windows too often.
• Moving the cursor accross tables and BR elements didn't work correctly.
• When a character '&' appeared in an ALT attribute (and in some other attributes), it was saved as is in the HTML file. It's now saved as '&amp;'
• The use of autoconf has been improved to make the Amaya building easier (suggestions from Sam and Adam).

Amaya 1.3b

October 14, 1998

New Features:

• Whenever there's an authentication failure, Amaya will ask the user if he wants to retry or abandon the operation.

• It's now possible to configure different network related timeouts thru the registry file

• Amaya now uses the DEFLATE transfer encoding in the HTTP headers
• It's now possible to double-click within Windows selectors (Open Document, Spell-checker, etc.)

Fixed bugs 1.3b:

• Amaya generated line breaks into script and style elements. That has been fixed now.
• Sometimes the Backward and/or Forward buttons didn't work fine if you had successively loaded local and HTTP documents. Now it works.
• There was still a bug in vertical table formatting.
• While saving a remote document which was just edited, Amaya reported a failure of the operation, even if it was a success
• When Amaya save a document locally, the user can now give a relative path or the "~/xxx" path for images but the corresponding directory need to be created before.
• While browsing a protected site, Amaya could prompt the user many times for its password (bug inside the new libwww)
• When a paragraph was right aligned and updated, the current line could be not redisplayed correctly.
• When changing the type of an existing element (for instance changing a H2 into a Paragraph), the following elements (H2 elements in that case) were not renumbered correctly.
• The Windows version couldn't print the help page of Math.
• When MULTI_KEY is active the input method has been modified to support the ó character.

Amaya 1.3a

September 25, 1998

New Features:

• Amaya tries to save modified documents when it crashes. Then, the next Amaya session proposes to reload theses documents when it starts.
• Target anchors are no longer displayed in green. All elements which can be used as a target for a link show a target icon. These icons are always visible in the "Links" view. In the "Formatted view", the user has to ask Amaya to show them. An entry "Show targets" in the "Views" menu alternatively shows or hides target icons in the "Formatted view". When the user wants to create a link to a specific element, s/he must click on the corresponding target icon.
• New version of the jpeg library (except for the Windows version).
• Amaya uses the latest version of libwww. This version provides Amaya with an up-to-date implementation of HTTP/1.1 including pipelining and caching
• Amaya can save documents in XML. Command Save As proposes 3 output formats: HTML, XML, Plain text. When a document is saved in XML, the usual HTML structure is used, but it is written in the XML language.
• Conversely, Amaya can read HTML documents written in XML. These documents can then be edited and saved in HTML, XML or plain text.
• When saving a document in XML, namespaces are used if the document contains XML elements such as mathematical expressions in MathML or 2D vector graphics.
• The following HTML 4.0 elements are available: NOSCRIPT, LABEL, BUTTON.
• Some support is provided for frames: the parser recognizes tags FRAMESET, FRAME, and NOFRAMES as well as their attributes and Amaya displays them as if they were links. You can double click them to fetch the corresponding page.
• The following HTML 4.0 attributes are available: onload, onunload, charset, hreflang, target, accesskey, tabindex, onfocus, onblur, media, longdesc, declare, archive, standby, valuetype, object, onsubmit, onreset, accept-charset, disabled, readonly, onselect, onchange, accept, label, char, charoff, summary, frame, rules, datapagesize, abbr, axis, headers, scope, profile, scheme, language, defer, event, for
• All HTML 4.0 character entities are accepted by the HTML parser and are generated when saving HTML files.
• You can create STYLE and SCRIPT elements with the Structure menu in the Structure_view.
• You can edit the content of elements STYLE and SCRIPT in the Structure_view.
• Characters that are not available on the keyboard can be entered by key sequences. For instance, e acute is entered by pressing key ' and then key e. This multi-key support is now available on Windows platforms. On Unix and Windows it is optional and needs to be requested by setting "ENABLE_MULTIKEY=YES" in the registry file ($HOME/.thotrc for Unix platforms or Thot/config/thot.rc for Windows platforms).
• Amaya fixes nested lists generated by Mozilla: when a OL or UL is a child of another OL or UL, the former is considered by the Amaya parser as a child of its previous LI sibling. According to the HTML DTD, the only allowed children for a UL or OL are LIs.

Fixed bugs 1.3a:

• Improvement of the auto-scroll on dragging and availability on Windows version.
• Improvement of the printing of tables: when a table was split by a page break, the page header and the page footer were overlapped by some table elements.
• To be consistent with other editors, the management of the Backspace is modified. With a non-empty selection the Backspace deletes the current selection but not the previous character.
• Improvement of CSS parsing. Style commands (format, colors, etc.) are also improved.
• Sometimes it was impossible to copy/paste from Amaya to another application.
• Improvement of form handling:
  • Password fields in forms showed the text which is being typed in.
  • Some special characters in the query string were not being correctly escaped.
  • There was a limitation on the size of the query string.
  • It wasn't possible to type a CR in the textarea zone
• When the user filled a form, Amaya considered that the document had been modified, as if one were in an edition mode, rather than in a browsing one
• The default color of ReadOnly documents is now black.
• Bullets in UL elements didn't grow with the UL size.
• When saving a document, the document status was set unmodified even if the operation failed. "Save As" could change attributes URL and SRC. If the saving failed old values were lost. Now Amaya restores the previous document state.
• Improvement of the vertical table formatting.
• Broken connection pipes weren't taken into account under AIX

Known bugs:

• By integrating the newest libwww, we got a very good implementation of HTTP/1.1. However, this version of the library can be fragile when contacting badly implemented HTTP/1.0 servers. For example, servers that don't send the correct headers or which don't understand the 1.1 protocol version in the request.
• Pushing the stop button in any document window closes all the open connections in all the document windows.
• Entities in URLs should be converted before being sent to the server.

Amaya 1.3

July 10, 1998

New Features:

• Print on Windows is now available.
• "Zoom In" and "Zoom Out" functions are now available.
• Amaya uses the standard clipboard. On Windows versions Copy/Paste takes the standard clipboard into account. On Unix versions, Copy form clip board and Paste form Clipboard are attached to the usual mouse buttons (Left and Middle). Consequently, selection extension is now performed by the Shift + Left button of the mouse.
• The drag now generates an auto-scroll (not available on Windows).
• There is a new input method for Iso-Latin-1 characters. According to the following table one can obtain a 'ã' by first pressing '~' then typing 'a'. To obtain a simple '~' you have to press '~' twice.

  accent-letter	~	`	'	"	*	^
  a A	ã Ã	à À	á Á	ä Ä	å Å	â Â
  c C		ç Ç
  e E		è È	é É	ë Ë		ê Ê
  i I		ì Ì	í Í	ï Ï		î Î
  n N	ñ Ñ
  o O	õ Õ	ò Ò	ø Ø	ö Ö		ô Ô
  u U		ù Ù	ú Ú	ü Ü		û Û
  y Y		Ý	ý Ý

• Alt and Control keys are dedicated to shortcuts

• Matrices and tables (mtable) from MathML are supported.

• XML links (only simple links) are supported in MathML: any MathML element can have the two attributes xml:link="simple" href="some/URL"
• Elements deprecated in HTML 4.0 can't be created with Amaya.
• The HTML parser replaces the obsolete elements LISTING, PLAINTEXT, XMP by PRE.

• The following HTML 4.0 elements are available: ABBR, ACRONYM, BDO, DEL, IFRAME, INS, OBJECT, PARAM, Q, SPAN, TBODY, TFOOT, THEAD (BDO does not change the writing direction on the screen)

• The following HTML 4.0 attributes are available: id, class, style, title, lang, dir, onclick (and all other events), cite, datetime
• There is a new CSS parser. In that release, it's not possible to edit CSS files in Amaya but this will be available very soon.
• Tooltips are now available on Windows and are updated on Unix versions.
• Libraries libz and libpng are updated.

Fixed bugs:

• Amaya didn't accept a table within a form. The form editing has been also improved.
• Amaya is now able to manage row-spanned cells which are higher than the spanned rows.
• The install is now minimum: only amaya and print are installed.
• When accesing a protected site, an authentication dialogue appeared for each URL
• When reloading a page, Amaya wasn't sending any No-Cache headers

Fixed bugs in Amaya 1.2a

March 27, 1998

New: When Amaya crashes on Unix platforms, modified documents are now automatically saved in temporary files $HOME/.amaya/%name.html.

• Sometimes when creating a link Amaya crashed.
• Amaya could also crashed if the user edited a page when Amaya was downloading a new one.
• Back button didn't work sometimes when aborting the reload of a document.
• Couldn't follow local relative links when they specified the name of the document.
• Back button didn't work sometimes when aborting the reload of a document.
• Improving table editing and formatting.
• Table are now displayed differently in Alternate view.
• On windows platforms, the scroll could carry on pieces of overlapping windows.
• There was a problem with picture display when the document was scrolled.
• Amaya didn't download the new image when the attribute SRC was edited.

• Areas with shape=rectangle or circle were not updated when the associated image was resized and Amaya didn't redisplay correctly an image when width and/or height attributes were deleted.

• Error in area map parsing.
• Amaya didn't manage bacground images like other image in documents. Now Amaya is able to compute their relative URLs and save them.

• During parsing, when anchors were not properly closed Amaya repeated them.

• Hitting the Enter key several times at the end (or beginning) of a table created a new, empty table. It now creates an empty element after (or before) the table.

• Hitting the Enter key when a HR is selected created an additional HR. It now creates an empty element after the selected HR

• Amaya was stuck in an infinite loop when a BR was deleted by BackSpace.
• Document was not set modifed when a link was changed or a span was created and modifications could be lost.
• When opening the CSS Dialog window my .amaya.css file was not automatically opened and loaded. Windows users can now define a User's Preferences file: Thot/amaya/amaya.css.
• When clicking on remove icon in CSS Dialog Amaya crashed.
• After modifying CSS the Save button popped up an infinite number of save windows.

• There were memory leaks in windows version.

Amaya 1.2

February 4, 1998

Windows improvements:

• handling of the stop button
• keyboard shortcuts for editing commands
• saving as a PostScript file
• scrolling and editing

Global improving (Windows and Unix versions):

• table formatting: a new implementation has been done
• extension to support Latin 2 languages in documents
• proxy specification
• further work on the MathML application
• other minor bugs

Fixed bugs in Amaya 1.1c

November 17, 1997

The following points are improved in Windows version:

• 256 color mode for windows,
• background images and image transparency,
• keyboard management,
• opening files from text zones and toolbar management,
• HTML forms,
• links management in local files.

Global improving (Windows and Unix versions):

• CSS background rule,
• saving in ASCII format,
• editing of hotzones in image maps (not available yet in Windows version),
• the "Make Book" function,
• the help in line,
• other minor reported bugs are now fixed.

New features in Amaya 1.1

July 10 and September 15, 1997

Extensions

• Anchors and ID attributes:
  • When Amaya parses a document it checks that all MAPs have a different NAME, and it changes duplicate NAMEs. The USEMAP attribute of the related IMG element is updated accordingly.
  • The function "Create Target" generates an attribute NAME or ID depending on the current selection. - If the DTD allows the insertion of an anchor as the parent of the current selection, Amaya creats an anchor and takes the first included word of more than 3 characters as the value of the NAME attribute. - If a single structured element is selected (DIV, H1, etc.), Amaya generates an ID attribute for this structured element. The ID value is generated, like the NAME value, after the included text. Amaya checks that the new NAME or ID value is unique. If it's not the case it changes the value by adding a number at the end of the word. For example, it generates "value1" if "value" already exists in the document.
  • When an anchor with a NAME attribute or an element with an ID attribute is pasted, Amaya checks that the new NAME or ID value is unique and changes it if it's not unique.
  • Functions which create a MAP element generates automatically a NAME with value "map". Amaya checks that the new NAME value is unique.
  • When an IMG with a USEMAP attribute is pasted, Amaya remove this attribute, and when an IMG with a USEMAP attribute is deleted, it does take care of the related MAP element. The document author is supposed to delete this MAP or to link it to another IMG element.
• Links:

  The functions "Create Link" and "Change Link" create an anchor if the DTD allows the insertion of an anchor as the parent of the current selection. Then the user can click a target anchor or a target document or a structured element with an ID attribute. - If it's not a valid target, Amaya displays a form to insert the HREF value. - If the user clicks on a valid target, Amaya generates automatically the HREF value. In both cases, Amaya transforms the HREF value to make it relative to the document base (the BASE element value or the current document URL).

  When an anchor with a HREF attribute is pasted, Amaya transforms the HREF value to make it relative to the document base.

• Images:

  The function "Create Image" creates the SRC value relatively to the document base (the BASE element value or the current document URL). Amaya also creates the ALT attribute and initializes its value with the image name.

  When an IMG is pasted, Amaya transforms the SRC value to make it relative to the document base.

• Publishing:

  • Button "Copy Images" indicates that images have to be copied into: - the new document directory (on the remote server or locally), - the new image directory, if there is a specified image directory.

  • Button "Transform URLs" indicates that all URLs and SRCs are recomputed when saving the document. In both cases, Amaya generates relative URLs when it's possible.

• Customization: Each user can define his/her personal file HTML.conf in his/her HOME directory. So each individual user can now customize size and position of Amaya windows.
• Java: Upgraded to Kaffe-0.9.1 using the JDK 1.1.2 classes. The mechanism to access Java objects content has been cleaned up and should be ready for 64 bit targets. Java stubs are not distributed anymore, the Makefiles produced by autoconf build them on the fly to avoid conflict in case of changes in the HTML schemas. General improvements for the Java classes embedding access to the document C objects.
• Math: This version of Amaya contains an embryonic MathML editor, that allows mathematical expressions to be embedded in HTML pages. It implements a subset of the MathML specification. This feature should be considered as a demonstration, as it is very incomplete. More in next releases.
• MS/Windows This is the first version of Amaya that runs on Microsoft Windows (both Windows 95 and Windows/NT).

Fixed bugs

• Spaces were not accepted in end tags. For instance, </STRONG > was considered invalid. It is accepted now.

• Amaya refused to create an Image before an Image. Now it works.

• Sometimes, active zones were not created.

• Using Style forms, the text was displayed correctly, but the style attribute registered the previous style value instead of the new one.

New features in Amaya 1.0 and 1.0a

April 3 1997 and May 7, 1997

Extensions

• A new command to create OBJECTs (HTML-Cougar) in Types menu.
• A plug-in mechanism allows OBJECTs to be executed.

• Attribute LANG (HTML-Cougar) is implemented (see Attributes menu)

• Elements SPAN (HTML-Cougar) are automatically created and deleted

• Two new views are available (see the Views menu):

  • Links view shows and allows to edit all links in the document.

  • Table of Contents displays and allows to edit all (and only) headings (Hn).

Like the Alternate and Structure view, these new views are "synchronised" with the other views of the document. These views can be printed with the document (see the Setup and Print command)

• The Help button loads the Amaya documentation.

• New menu "Special" with the following commands:

  • Transform (was the last item of the Types menu): structure transformations

  • Section Numbering: numbers headings (Hn) in the main view and in the table of contents. Numbers are automatically updated when headers are inserted or deleted. Section numbers are not saved with the document, but they are printed if numbering is active when the Print command is issued.

  • Make Book: allows to merge several HTML documents into a single one (for printing a collection, for instance). This is based on typed links (rel="chapter").
• Printing has been extended:
  • "Setup and Print": this command proposes to change print options before printing. Parameters ManualFeed, Table of contents, Numbered links and default PostScript file name are reset when a new document is printed. New options are:
  • Table of contents: prints the Table_of_contents view of the document.
  • Numbered links: numbers links in the main view and prints them.
  • "Print": this command prints the document with the print parameters defined in previous "Setup and Print" command.
• Directories are no longer automatically browsed when the user inserts them in the "Open Location" form. A new button (List) is added in this form that allows to explicitly browse the current directory.
• It's now possible to extend dictionaries used by the spell-checker. When the user clicks on a (+dic) button in the spell-checker form, the current word is added to the common extensible dictionary. By default this common dictionary is located in $HOME/.thot.DIC, but the user can change this location in the .thotrc registry: EXTENDDICT=
• Documents can be saved in text form (see Save As command), with a list of URLS for external links.
• Images are zoomed according to attributes width and height. Combining the Control key with the Middle button of the mouse allows the user to easily resize an image.
• CSS: More properties are supported: background-color, background-image, background-repeat, text-align.
• The registry now supports $(MACHINE) for architecture dependent paths.
• Java support: Amaya now integrates the Java Kaffe runtime. This version uses the Jigsaw HTTP/1.1 classes to do network access, and provide a user cache. Most of the Thot API is available from the Java language offering an easy customization path for Amaya users. This also simplifies significantly the use of Amaya as a testbed since a lot of developements are done in Java and can easily be integrated to the existing base.
• HTML markup is now in lowercase, to improve efficiency of compression tools.

Fixed bug

• When saving a document in HTML, Amaya omitted quotes around some attribute values.
• When inserting an anchor around a sample image, the image was sometimes lost.
• On 1 bit per pixel screens, buttons in dialog boxes were entirely black and selection was invisible.
• Amaya didn't select any element or character when the mouse was out of document limits.
• Some improvements to table formatting (cells containing a single IMG with a width attribute are formatted correctly).
• Creation of new definitions (DD) at the beginning of a definition list (DL) is now possible.
• Amaya tried to interpret "&" followed by a non-letter as an entity. It's now interpreted as ordinary text.
• When a <TD> tag follows a <TABLE> tag without a <TR> in between, a WIDTH attribute associated with <TD> was considered invalid.
• Amaya created additional <P> tags in table cells and list items.
• tags such as <B>, <I>, <EM>, etc. caused troubles in <PRE> elements.

New features in Amaya 0.95b

January 9, 1996

Extensions

• Attributes height and width are taken into account for IMG, TD and TH.
• Tooltips (aka tips) are available on buttons.
• A message is displayed at the bottom of the window when the document is saved.
• Creation of definition lists (DL) is easier.
• Added Two new buttons, to create links and tables.
• Amaya can now uncompress gziped HTML files.
• Sends an Accept header corresponding to the MIME types Amaya can display

Fixed bugs

• The main view (Formatted_view) of HTML documents was always placed at the top left corner of the screen. The position specified in the HTML.conf file was ignored.
• Under certain conditions, it was possible to create several BODY or HEAD elements in the same document.
• It was sometimes necessary to activate the Close View command twice for actually closing the Structure view.
• In some tables, columns containing badly structured cells were sometimes moved to the left side of the table.
• When an image was within a paragraph with some text, and with a caret on its right or left edge, pressing keys Enter, Del and BackSpace led to strange results.
• Submitting a form always sent the value attribute of the Submit button, regardless of whether a name attribute was present or not. Other minor problems with form selection were fixed up.
• Amaya didn't support invalid base like a complete document URL.
• Amaya didn't support invalid attributes in BASE element.
• Under certain conditions, copy and paste of images between documents didn't work.
• Under certain conditions, some images were not published.
• When publishing, Amaya did not sent a Content-Type header.

New features in Amaya 0.9

November 14, 1996

Extensions

• Structure transformation (command Types/Transform)
• more efficient pattern matching algorithm
• more structure checking: transformations are not proposed to the user if they lead to an invalid structure (even if the transformation is matched with the selection).
• the last modification time of the file HTML.trans is checked before it is parsed.
• in version 0.8, if the parser detects an error in file HTML.trans, the transformation process is stopped. Now, the parser skips the invalid transformation.
• error messages are displayed at the bottom of the window.
• Color palette
• The palette highlights the foreground and background colors of the element selected when the palette is opened. The highlight allows users to choose the same colors for different elements.
• It is also possible now to remove a color attribute from an element just using the "standard color" button in the palette.
• Forms
• forms can now be sent using GET and POST methods to protected/unprotected URLs
• creation of form components has been improved
• you can activate buttons and menu options by double-clicking them.
• HTML 3.2
• the latest extensions of HTML 3.2. have been added: tag BASEFONT and attributes width and height for tags TH and TD.
• It is now possible to add comments in HTML documents (use command Structure/Comment in the Structure view)
• User Interface
• When the current selection is within a PRE element, some menu entries are disabled: Image in Types menu, and Big, Small, Sub, Sup, and Font in Character Element menu.
• Interpretation of "~" and "file:" in "Open" and "Save As" dialogue boxes
• In previous versions, I B and TT buttons were never updated when selection changed. Now they are displayed according to the current selection.
• Continuous scroll: the document scrolls as you move the slider
• Distinction between "Cancel" and "Done" buttons in dialogue boxes.
• When opening the Structure view, the document is displayed with the selected part visible in that view.
• Environment variables are initialized from the Registry (file thot.ini)
• Integration of libwww5.0a, giving among other things: HTTP/1.1 and keep-alive connections.
• Reload button and command (File/Reload Document).
• Spell checker is now available for English and French, but both dictionaries are far from complete.

Bug fixes

• Closing an Amaya window with a window manager command caused Amaya to crash. Now only the concerned window is closed.
• The HTML parser inserted a space at the beginning of a new line generated by a <BR> tag followed by new line in the source file.
• Call "Change link" from Links menu and click in the document itself. The dialog box for entering the URL of the target was empty in previous versions. Now it contains the current value of attribute HREF.
• Select some characters, call "Create link" from Link menu and click in the document itself. Do not enter anything in the dialogue box for the URL and press the Cancel button in this dialogue box. Later, call the Change link command for entering an actual URL for that anchor. Nothing happened in previous versions. Now you can change the URL.
• Some elements were lost during structure transformation, this is now fixed.
• Structure transformation was impossible if the selection contains comments or invalid elements. Now transformations are possible (invalid tags are removed in the new structure).
• In previous versions, if the input focus is in one window and you press the H1 button (or any other button of that kind) in another window (with a different document in it) it changes the first window. Now, the button does nothing.
• Colors management is completely re-casted and we hope to solve color problems in previous versions.
• An emphasized string (or strong or...) can now span several lines in a Preformatted.
• When the same Web image is shared by two loaded documents, just one local copy was created by Amaya and this copy was lost when the first document was closed. This choice causes troubles when user tried to publish the second document. Now Amaya creates two copies, one for each document.
• Copy and paste on images didn't work fine in previous release.
• Sometimes, local copies of remote documents were not created in the right place. Now it works.
• When user closed a document view with the Window Manager, the whole application exited. Now only the document view is closed.
• It is now possible to save a document if it is modified and close it.
• In the previous version, Amaya did not detect the cancel of the network save of an object to a protected URL space.
• Inserting an image from a local directory did not react well to errors. This has been corrected.
• Call "Create Link" when an target anchor is selected or "Create Target" when a link anchor is selected, Amaya refused to add the href or name attribute. Now it works.
• Call "Change Link" anywhere asked to select the destination. Now this function works only within an link anchor.
• After loading a lot of CSS files Amaya cannot load images because file descriptors are not freed. Now it is correct.
• The command "Save As" doesn't work or crashes. Now it is correct.
• Bug in area-mapping (circle) fixed.
• Support of the starting option -display
• If a user gave a wrong password, Amaya did not ask the user for the new password. It kept using the wrong one. Fixed.
• When typing in the WYSIWYG window, clicking e.g. the "Italics" button enters italics mode. After typing a few italic chars one wants to change back to normal mode. Clicking the "Italics" button once again achieves this. But you can't go on typing in normal mode, because this second click also selects the italic text to become the active (highlighted) region. Simply typing ahead overwrites the whole (italic) region. This bug is fixed.
• The implicit break following the <HR>failed to appear when a <FONT> tag follows <BR>. The text within the FONT construct appeared to the right ofthe horizontal rule. This bug is fixed
• When typing in the WYSIWYG window, clicking e.g. the "Italics" button enters italics mode. After typing a few italic chars one wants to change back to normal mode. Clicking the "Italics" button once again achieves this. But you can't go on typing in normal mode, because this second click also selects the italic text to become the active (highlighted) region. Simply typing ahead overwrites the whole (italic) region. This bug is fixed.
• Printing with "US" paper size did not work. Bug fixed.
• When changing attribut "align" for an element DIV containing paragraphs, the paragraphs were not redisplayed with the alignment defined by the attribute but they moved in a weird way in the Structure view. This bug is fixed.
• Select a DT and change its style: the DT element in the Structure view gets confused. Bug fixed.
• Selection was moved to its original position at the ned of command Edit/Find. It now stays at its current position.

 

---

G. Entering ISO-Latin-1 characters in Amaya

[Daniel Veillard, 1997/10/23 14:11:53, Keyboard.html]

Defining shortcuts

The file Amaya/bin/amaya.keyboard defines the current accelerators.

ISO-Latin-1 input support in Amaya

This document provides the complete list of keyboard input sequences allowing to enter all ISO-Latin-1 characters with a standard (e.g. North American) keyboard. These sequences were extracted from the X-Windows 11 rel 6 file describing the compose sequences for locale support of iso8859-1 standard, and therefore are expected to follow the appropriate standard (available in the file /usr/X11R6/lib/X11/locale/iso8859-1/Compose).

These input sequences are based on a three key sequence beginning with a modifier, the Alt key or the compose key depending on the keyboard type. For example, to obtain a `å' first press the Compose or Alt key, then type `a' and `*'. This principle also applies to capital letters: `È' is obtained by pressing Alt, then `e' with Shift pressed down, and the backquote key.

Notes :

• with Western European keyboards (like the French one) the keys commonly used for such sequences (like backquote, tilda, @ and backslash) are themselve obtained using the AltGr key plus another key, but these should work fine. `È' can be obtained on a French keyboard by entering the sequence <Alt>, <Shift> + `E', <AltGr> + `è', since backquote is mapped on <AltGr> `è'.
• When non-ascii characters are already mapped on the keyboard, this mapping should work fine with Amaya.
• The oelig (o and e ligature) and OElig (O and E ligature) are not part of the ISO-Latin-1, so Amaya cannot display them using the standard fonts. These characters are displayed as division sign for oelig and multiply sign for OElig.

Rules for ISO-Latin-1 input

Most of the input sequences are based on the following rules:

• the grave accent on a character is obtained by composing the character with a quote: á is obtained with <Alt> a and quote.
• the acute accent on a character is obtained by composing the character with a backquote: à is obtained with <Alt> a and backquote.
• the ring accent on a character is obtained by composing the character with a star: å is obtained with <Alt> a and star.
• the tilde accent on a character is obtained by composing the character with a tilda: ã is obtained with <Alt> a and tilda.
• the circumflex accent on a character is obtained by composing the character with a circumflex: â is obtained with <Alt> a and circumflex.
• the cedilla on a character is obtained by composing the character with a comma: ç is obtained with <Alt> c and comma.
• the umlaut on a character is obtained by composing the character with double quote: ä is obtained with <Alt> a and double quote.
• slashed characters are obtained by composing them with a slash: ø is obtained with <Alt> o and slash.
• ligatures are obtained by composing the first letter with the second one: æ is obtained with <Alt> a and e.

ISO-Latin-1 sequences table

name	number	first key	second key	Output
AElig	198	<Shift> A	<Shift> E	Æ
Aacute	193	<Shift> A	quote	Á
Acirc	194	<Shift> A	circumflex	Â
Agrave	192	<Shift> A	backquote	À
Aring	197	<Shift> A	star	Å
Atilde	195	<Shift> A	tilda	Ã
Auml	196	<Shift> A	double quote	Ä
Ccedil	199	<Shift> C	comma	Ç
Eth	222	-	D	Ð
Eacute	201	<Shift> E	quote	É
Ecirc	202	<Shift> E	circumflex	Ê
Egrave	200	<Shift> E	backquote	È
Euml	203	<Shift> E	double quote	Ë
Iacute	205	<Shift> I	quote	Í
Icirc	206	<Shift> I	circumflex	Î
Igrave	204	<Shift> I	backquote	Ì
Iuml	207	<Shift> I	double quote	Ï
Ntilde	209	<Shift> N	tilda	Ñ
Oacute	211	<Shift> O	quote	Ó
Ocirc	212	<Shift> O	circumflex	Ô
Ograve	210	<Shift> O	backquote	Ò
Oslash	216	<Shift> O	slash	Ø
Otilde	213	<Shift> O	tilda	Õ
Ouml	214	<Shift> O	double quote	Ö
Thorn	222	<Shift> T	<Shift> H	Þ
Uacute	205	<Shift> U	quote	Ú
Ucirc	206	<Shift> U	circumflex	Û
Ugrave	204	<Shift> U	backquote	Ù
Uuml	207	<Shift> U	double quote	Ü
Yacute	221	<Shift> Y	quote	Ý
aelig	230	a	e	æ
aacute	225	a	quote	á
acirc	226	a	circumflex	â
agrave	224	a	backquote	à
aring	229	a	star	å
atilde	227	a	tilda	ã
auml	228	a	double quote	ä
brvbar	166	bar (pipe)	bar	¦
ccedil	231	c	comma	ç
cent	162	c	slash	¢
copy	169	c	o	©
current	164	x	o	¤
deg	176	circumflex	0 (zero)	°
eacute	233	e	quote	é
ecirc	234	e	circumflex	ê
egrave	232	e	backquote	è
euml	235	e	double quote	ë
eth	240	-	d	ð
frac12	189	/	2	½
frac14	188	/	4	¼
frac34	190	/	3	¾
hyphen	173	- (minus)	-	‐
iacute	237	i	quote	í
icirc	238	i	circumflex	î
igrave	236	i	backquote	ì
iexcl	161	! (exclam)	!	¡
iquest	191	? (question)	?	¿
laquo	171	< (inferior)	<	«
macr	175	- (minus)	circumflex	¯
micro	181	/	u	µ
middot	183	.	circumflex	·
nbsp	160	<Ctrl> space	(none)
not	172	- (minus)	comma	¬
ntilde	241	n	tilda	ñ
oacute	243	o	quote	ó
ocirc	244	o	circumflex	ô
ograve	242	o	backquote	ò
oslash	248	o	slash	ø
otilde	245	o	tilda	õ
ouml	246	o	double quote	ö
ordf	170	a	_ (underscore)	ª
ordm	186	o	_ (underscore)	º
para	182	<Shift> P	! (exclam)	¶
plusmn	177	+	- (minus)	±
pound	163	l	- (minus)	£
raquo	187	> (superior)	>	»
reg	174	<Shift> R	<Shift> O	®
sec	167	s	! (exclam)	§
sup1	185	s	1	¹
sup2	178	s	2	²
sup3	179	s	3	³
szlig	223	s	s	ß
thorn	254	t	h	þ
uacute	250	u	quote	ú
ucirc	251	u	circumflex	û
ugrave	249	u	backquote	ù
uuml	252	u	double quote	ü
yacute	253	y	quote	ý
yen	165	y	- (minus)	¥
yuml	255	y	double quote	ÿ

For a more complete list see HPAM (by J.M.B.), chapter 6.

 

---

H. Configuring your WWW server to understand the PUT method

[José Kahan, 1997/10/23 14:11:54, Put.html]

The Hypertext Transfer Protocol (HTTP) defines a PUT method as the mechanism allowing a WWW client to transfer a file to a WWW server. Amaya uses the W3C Reference Library implementation of HTTP to publish documents by means of this protocol method. As of today, not many WWW servers support the PUT method, but this is rapidly changing. Both the CERN server and Jigsaw support this method.

This document gives some hints on how to prepare a WWW server to handle the PUT method. We first give some general background on how a PUT request works. We then describe how to configure the CERN server to handle this kind of requests. While not providing extensive description on how to configure every existent PUT-compliant WWW server, we hope that this document will provide you enough material to put you on the right track.

Contributions on other server's configurations are welcome.

• Overview of a PUT operation
• Configuring the CERN for a PUT
• Configuring the Apache server for a PUT

For more information

• How to configure the APACHE server
• A features comparison chart for HTTP servers
• Jigsaw home page

 

---

I. How to install the Unix Amaya Binary Release

[Irène Vatton, 1998/03/27 14:11:24, Install.html]

In the following, we assume that the path stored in the archive begins with the Thot directory (this change was introduced for the source distribution). Older binary distributions use Amaya as the top directory name instead.

Choose a place for Amaya

Supposing the binary distribution was loaded fine, one must choose a place to install it. We suggest

• /usr/local for a system wide installation
• the user home directory for a personnal installation

A Linux version doesn't need more that 5 Megabytes of disk space, even a RISC architecture distribution should not exceed 10 Megabytes.

Extract the distribution

Move the distribution to this directory, check that the rights on this directory allow you to create a directory and extract the distribution.

On a Linux ELF platform one must invoke:

tar xvzf amaya-linux-elf-Release.tar.gz

Where Release has to be replaced by the current verion number.

More generally if the distribution is a tar.gz file:

gunzip -c amaya-Platform-Release.tar.gz | tar xvf -

Whatever the method used, this should print around 40 lines of output and create a new directory called Thot populated with a few files and directories. If not, your distribution file was probably corrupted during transfer, please get a new one. Read carefully the COPYRIGHT, README and AboutThot files.

Set up the environment and start Amaya

The file Thot/SYSTEM/bin/amaya is the Amaya binary, the best thing is to add the path to the Thot/SYSTEM/bin directory to your PATH environment variable. For example on a Linux-ELF system:

setenv PATH $PATH:/usr/local/Thot/LINUX-ELF/bin

for a csh or tcsh shell. When using sh, bash or another variant of the Bourne shell

PATH=$PATH:/usr/local/Thot/LINUX-ELF/bin ; export PATH

Maybe this command should be added to the .login startup script. Once done one can lauch Amaya simply by typing "amaya" to the shell prompt. The Amaya main window should open and display the first page of the Amaya documentation.

If something goes wrong

• If Amaya doesn't seems to work, check the following points:
  1. the DISPLAY variable is correctly set.
  2. eventually remove your previous registry file $HOME/.thotrc.
  3. The binary just installed is the correct one, i.e. it is the correct binaries for the current machine (don't try to start the Linux-ELF version on a Solaris machine or an old Linux a.out installation).
  4. If the binary version is ok, check the availability of the dynamic libraries needed by the executable file amayamain (located under Thot/bin/SYSTEM/amaya). for example on a Linux-ELF system type

     ldd Thot/LINUX-ELF/bin/amaya

     and check that there is no missing libraries.

• One can install packages for different platform under the same directory (for example on a server filesystem exported via NFS to an heterogenous set of machines), use the appropriate PATH on each platform.
• All the traffic on the Amaya mailing-list is archived here. Please have a look at it before sending us mail if something goes wrong. Remember, it's an Alpha release.

---

Copyright © 1997 W3C (MIT, INRIA, Keio ), All Rights Reserved. W3C liability, trademark, document use and software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.

---

Back/forward to the:

• Computer Manuals at the Sternwarte Bonn
• Sternwarte Bonn Homepage
• Computer System of the Sternwarte  (only available locally)
• W3C Amaya Site

---

First version:	26th	June,	1998
Last update:	04th	November,	1999

---

Jochen M. Braun   (responsible for slight adaptions, not for the content of this document)
 (E-Mail: jbraun@astro.uni-bonn.de)

---