mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-06 23:02:28 +01:00
work in progrss intermediate save
Updated wikipage Writing Documentation Filters with EFF, the Eiffel Filter Format. (Signed-off-by:RTH10260). git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2306 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
@@ -1,5 +1,5 @@
|
||||
[[Property:link_title|Writing Documentation FiltersFilters with EFF, the Eiffel Filter Format]]
|
||||
[[Property:modification_date|Sat, 13 Feb 2021 06:57:35 GMT]]
|
||||
[[Property:link_title|Writing FiltersFilters with EFF]]
|
||||
[[Property:modification_date|Sun, 14 Feb 2021 04:47:20 GMT]]
|
||||
[[Property:publication_date|Thu, 11 Feb 2021 07:55:20 GMT]]
|
||||
[[Property:title|Writing Documentation Filters with EFF, the Eiffel Filter Format]]
|
||||
[[Property:weight|6]]
|
||||
@@ -178,88 +178,296 @@ Several extra items may be used and accessed through: $item$.
|
||||
|
||||
In every construct, the following items are defined:
|
||||
<code>
|
||||
$generator$ "ISE EiffelStudio version x.x.x"
|
||||
$generator$ "ISE EiffelStudio version x.x.x"
|
||||
|
||||
$html_meta$ HTML specific. Entire indexing clause defined as meta data.
|
||||
Example: "<META NAME="keywords" CONTENT="eiffel, O-O">".
|
||||
$html_meta$ HTML specific. Entire indexing clause defined as meta data.
|
||||
Example: "<META NAME="keywords" CONTENT="eiffel, O-O">".
|
||||
|
||||
$class$ Classname in uppercase. If currently processed file does
|
||||
not represent an Eiffel class, is empty.
|
||||
$class$ Classname in uppercase. If currently processed file does
|
||||
not represent an Eiffel class, is empty.
|
||||
|
||||
$title$ Title for current document.
|
||||
Example: "EV_ANY Text".
|
||||
$title$ Title for current document.
|
||||
Example: "EV_ANY Text".
|
||||
|
||||
$root$ Relative base directory of generated documentation.
|
||||
Example: "../../../../"
|
||||
$root$ Relative base directory of generated documentation.
|
||||
Example: "../../../../"
|
||||
</code>
|
||||
|
||||
====Properties====
|
||||
|
||||
<code>
|
||||
suffix |html
|
||||
Used to specify suffix used for this format.
|
||||
Examples: html, txt, ps, e, etc.
|
||||
suffix |html
|
||||
Used to specify suffix used for this format.
|
||||
Examples: html, txt, ps, e, etc.
|
||||
|
||||
file_separator |/
|
||||
Specify when format requires a specific file separator.
|
||||
For HTML, specify '/'. If this symbol is omitted, the separator
|
||||
specific for the platform is used.
|
||||
file_separator |/
|
||||
Specify when format requires a specific file separator.
|
||||
For HTML, specify '/'. If this symbol is omitted, the separator
|
||||
specific for the platform is used.
|
||||
</code>
|
||||
|
||||
====Basic Text====
|
||||
|
||||
<code>
|
||||
basic |*
|
||||
Basic text
|
||||
basic |*
|
||||
Basic text
|
||||
</code>
|
||||
|
||||
====Hyperlinking items====
|
||||
|
||||
<code>
|
||||
menu_bar |*
|
||||
Contains the different menu items.
|
||||
menu_bar |*
|
||||
Contains the different menu items.
|
||||
|
||||
menu_item |*
|
||||
Any of the global menu items, "Classes", "Clusters", etc.
|
||||
If not specified, no text is processed, since without hyperlinking
|
||||
menu items are useless.
|
||||
Symbol: $file$
|
||||
menu_item |*
|
||||
Any of the global menu items, "Classes", "Clusters", etc.
|
||||
If not specified, no text is processed, since without hyperlinking
|
||||
menu items are useless.
|
||||
Symbol: $file$
|
||||
|
||||
class_menu_item |*
|
||||
A link to one of the specified class formats.
|
||||
If not specified, no text is processed.
|
||||
Symbol: $file$
|
||||
class_menu_item |*
|
||||
A link to one of the specified class formats.
|
||||
If not specified, no text is processed.
|
||||
Symbol: $file$
|
||||
|
||||
menu_item_disabled |*
|
||||
The current format.
|
||||
menu_item_disabled |*
|
||||
The current format.
|
||||
|
||||
class_menu_item_disabled|*
|
||||
-- The current format.
|
||||
class_menu_item_disabled |*
|
||||
The current format.
|
||||
|
||||
cluster_name |*
|
||||
-- Symbol: $file$.
|
||||
cluster_name |*
|
||||
Symbol: $file$.
|
||||
|
||||
tooltip |*
|
||||
-- Text contained within this construct requests a tooltip.
|
||||
-- Symbol: $tooltip$.
|
||||
-- HTML Example: <SPAN TITLE="$tooltip$">*</SPAN>
|
||||
tooltip |*
|
||||
Text contained within this construct requests a tooltip.
|
||||
Symbol: $tooltip$.
|
||||
HTML Example: <SPAN TITLE="$tooltip$">*</SPAN>
|
||||
|
||||
origin_comment |*
|
||||
-- Text describing the written class of a feature.
|
||||
-- Example: -- from ANY
|
||||
origin_comment |*
|
||||
Text describing the written class of a feature.
|
||||
Example: -- from ANY
|
||||
</code>
|
||||
|
||||
====xxx====
|
||||
====Major syntactical constructs====
|
||||
|
||||
<code>
|
||||
class_declaration |*
|
||||
Contains entire document.
|
||||
HTML Example: <HTML><BODY>*</BODY></HTML>
|
||||
|
||||
indexing_clause |*
|
||||
|
||||
class_header |*
|
||||
Contains class header, not including formal generics.
|
||||
|
||||
formal_generics |*
|
||||
|
||||
obsolete_clause |*
|
||||
|
||||
inheritance |*
|
||||
|
||||
creators |*
|
||||
|
||||
feature_clause |*
|
||||
|
||||
feature_declaration |*
|
||||
Entire feature declaration. Symbol:
|
||||
$feature$ The name of the decalred feature.
|
||||
HTML example: <A NAME="$feature$">*</A>
|
||||
|
||||
invariant_clause |*
|
||||
|
||||
class_end |*
|
||||
</code>
|
||||
|
||||
====xxx====
|
||||
====Eiffel syntax items====
|
||||
|
||||
<code>
|
||||
features |*
|
||||
Eiffel feature reference. Symbols:
|
||||
$feature$ actual feature name of feature in class where it is written.
|
||||
$file$ link to class where feature is written.
|
||||
HTML example: <A HREF="$file$#$feature$">*</A>
|
||||
|
||||
keyword |*
|
||||
Processed when a keyword is encountered but it is not explicitly specified.
|
||||
|
||||
keyword_features |*
|
||||
Operator keyword or "Precursor"
|
||||
If not specified, "keyword" is processed.
|
||||
$file$ and $feature$ are defined, like for "features".
|
||||
|
||||
symbol |*
|
||||
Processed when a symbol is encountered but it is not explicitly specified.
|
||||
|
||||
symbol_features |*
|
||||
Operator symbol. If not specified, "symbol" is processed.
|
||||
$file$ and $feature$ are defined, like for "features".
|
||||
|
||||
reserved_word |*
|
||||
`Result' or `Current'.
|
||||
|
||||
comment |*
|
||||
Example.
|
||||
|
||||
comment_url |*
|
||||
A URL in a comment. If not specified, "comment" is processed.
|
||||
Symbol $file$ contains the URL.
|
||||
|
||||
string |*
|
||||
Eiffel literal string.
|
||||
|
||||
string_url |*
|
||||
A URL inside an Eiffel string. If not specified, "string" is processed.
|
||||
Symbol $file$ contains the URL.
|
||||
|
||||
quoted |*
|
||||
|
||||
character |*
|
||||
|
||||
number |*
|
||||
|
||||
local_symbol |*
|
||||
|
||||
assertion_tag |*
|
||||
|
||||
indexing_tag |*
|
||||
|
||||
generic |*
|
||||
Formal generic class.
|
||||
</code>
|
||||
|
||||
====xxx====
|
||||
====Whitespace processing====
|
||||
|
||||
<code>
|
||||
tab |*
|
||||
HTML Example: " %; %; %; %;".
|
||||
|
||||
new_line |*
|
||||
HTML Example: "<BR>".
|
||||
|
||||
multiple_spaces |*
|
||||
In case a sequence of spaces are encountered, this symbol is used for all subsequent spaces.
|
||||
HTML Example: " %;".
|
||||
</code>
|
||||
|
||||
====Eiffel keywords====
|
||||
|
||||
<code>
|
||||
interface |*
|
||||
Appended to keyword "class" in short and flat-short forms.
|
||||
|
||||
alias |*
|
||||
all |*
|
||||
as |*
|
||||
check |*
|
||||
class |*
|
||||
create |*
|
||||
debug |*
|
||||
deferred |*
|
||||
do |*
|
||||
else |*
|
||||
elseif |*
|
||||
end |*
|
||||
ensure |*
|
||||
expanded |*
|
||||
export |*
|
||||
external |*
|
||||
false |*
|
||||
feature |*
|
||||
from |*
|
||||
frozen |*
|
||||
if |*
|
||||
indexing |*
|
||||
infix |*
|
||||
inherit |*
|
||||
inspect |*
|
||||
invariant |*
|
||||
is |*
|
||||
like |*
|
||||
local |*
|
||||
loop |*
|
||||
obsolete |*
|
||||
old |*
|
||||
once |*
|
||||
precursor |*
|
||||
prefix |*
|
||||
redefine |*
|
||||
rename |*
|
||||
require |*
|
||||
rescue |*
|
||||
retry |*
|
||||
select |*
|
||||
separate |*
|
||||
strip |*
|
||||
then |*
|
||||
true |*
|
||||
undefine |*
|
||||
unique |*
|
||||
until |*
|
||||
variant |*
|
||||
when |*
|
||||
|
||||
Operators:
|
||||
|
||||
and |*
|
||||
and then |*
|
||||
implies |*
|
||||
not |*
|
||||
or |*
|
||||
or else |*
|
||||
xor |*
|
||||
</code>
|
||||
|
||||
====Eiffel symbols====
|
||||
|
||||
<code>
|
||||
:= |*
|
||||
: |*
|
||||
%, |*
|
||||
-> |*
|
||||
%-- |*
|
||||
$ |*
|
||||
. |*
|
||||
.. |*
|
||||
" |*
|
||||
= |*
|
||||
! |*
|
||||
> |*
|
||||
>= |*
|
||||
<< |*
|
||||
[ |*
|
||||
{ |*
|
||||
( |*
|
||||
< |*
|
||||
<= |*
|
||||
' |*
|
||||
>> |*
|
||||
] |*
|
||||
} |*
|
||||
) |*
|
||||
?= |*
|
||||
; |*
|
||||
~ |*
|
||||
|
||||
Operators:
|
||||
|
||||
+ |*
|
||||
- |*
|
||||
%* |*
|
||||
/ |*
|
||||
// |*
|
||||
\\ |*
|
||||
^ |*
|
||||
/= |*
|
||||
</code>
|
||||
|
||||
====Obsolete filter constructs====
|
||||
|
||||
<code>
|
||||
!! |*
|
||||
creation |*
|
||||
cluster_declaration |*
|
||||
cluster_header |*
|
||||
</code>
|
||||
|
||||
Reference in New Issue
Block a user