Aida Mode Help
| Name: | Aida Mode |
| Version: | 2.1 |
| Last update: | 2019-11-27 14:12:58 |
Introduction
Aida mode is a mode for the text editor Alpha: it is designed to facilitate
editing and processing of documentation files written in the Aida
markup language (files with .aida, .ainc or .ainp
extensions).
Once it is in Aida mode, Alpha displays a menu (called Aida)
in the menu bar. The commands in this menu let you perform tasks such as
converting Aida files to various output formats (like HTML, PDF, Text,
Markdown, etc.) and inserting tags and templates in the document. Aida mode
also provides syntax coloring and file marking.
In order to test the Aida mode functionality, you can open
the Aida Example file, and then try using the
various menu items.
Aida Menu items
- Convert…
- This command brings a dialog in which you set the target format and the
input and output encodings before processing the current file.
- Aida Sections
- This submenu contains commands to insert section tags.
See the table below.
- Aida Structures
- This submenu contains commands to insert list and table tags.
See the table below.
- Aida Styles
- This submenu contains commands to insert style tags.
See the table below.
- Aida Links
- This submenu contains commands to create hyperlink tags.
See the table below.
- New Document
- This command creates a new Aida document with a default header.
- Insert Header
- This command inserts a default header in a source file.
- Display Palettes
- This commands displays floating menus containing the items found in
the submenus above (Sections, Structures, Styles, Links).
- Quick Reference
- Display a cheat list of all the Aida tags.
- Aida Help
- Display the Aida reference.
- Display Bindings
- Display the bindings currently defined in Aida mode.
- Menu Shortcuts...
- Define custom shortcuts for the menu items.
Aida Section Tags
| Command | Tag |
| Section 1 | ((s1 s1)) |
| Section 2 | ((s2 s2)) |
| Section 3 | ((s3 s3)) |
| Section 4 | ((s4 s4)) |
| Section 5 | ((s5 s5)) |
| Section 6 | ((s6 s6)) |
| New line | ((nl)) |
| Horizontal Rule | ((hr)) |
Aida Structure Tags
| Command | Tag |
| Ordered List | ((ol ol)) |
| Unordered List | ((ul ul)) |
| Description List | ((dl dl)) |
| Make Table | ((table border=0 table)) |
| Make Framed Table | ((table border=1 table)) |
| Eval Block | ((e e)) |
| If Block | ((if if)) |
| If Else Block | ((if ((else if)) |
Aida Style Tags
| Command | Tag |
| Italic | ((i i)) |
| Bold | ((b b)) |
| Underline | ((u u)) |
| Typewriter | ((y y)) |
| Quote | ((q q)) |
| Verb | ((v v)) |
| Verbatimize | ((w w)) |
Aida Link Tags
| Command | Tag |
| Anchor | ((a [label] ?txt? a)) |
| Reference | ((rf [url] rf)) |
| Hyperlink | ((lk [label] lk)) |
| Index Entry | ((x x)) |
The Mark pop-up menu
The marking procedure creates marks for all the sections of the current
document (within the limit set by the Mark Headings To Level
preference).
If the Auto Mark checkbox is checked in the preferences, the file
is automatically marked at opening.
Completions
There is a small set of electric completions in Aida mode.
Just type the following abbreviations
and hit the completion key to have them expanded to a complete structure:
Key bindings
A whole set of key bindings is available in Aida mode to trigger the menu
commands. Use the command Aida ↣ Display Bindings to display them or click here.
Aida Mode preferences
The Preferences… item in the Mode Setup submenu of the Alpha menu allows you to edit specific preferences for the
Aida mode.
Most variables are standard Alpha preferences (like Auto Mark, Prefix String, Word Break, Word Wrap) or color
preferences to customize the coloring schemes.
The Mark Headings To Level preference lets you specify the
maximum level of subsections to be marked in the marks popup (0 to 5).
Known problems
Please report any problem or bug you encounter to
Alpha's Bug Tracker.
License and Disclaimer
Copyright (c) 2010-2019, Bernard Desgraupes.
All rights reserved.
The Aida Mode package is free software and distributed under
the terms of the new BSD license:
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of Bernard Desgraupes nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BERNARD DESGRAUPES BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.