mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-06 14:52:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

work in progress intermediate save

Browse Source 
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@2307 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-14 05:03:11 +00:00
parent 0c285ddda4
commit bab2554f1d
1 changed files with 150 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

299
documentation/20.11/eiffelstudio/Tutorials/appendix-writing-documentation-filters-eff-eiffel-filter-format.wiki
View File

@@ -1,5 +1,5 @@
[[Property:link_title|Writing FiltersFilters with EFF]] [[Property:link_title|Writing FiltersFilters with EFF]]
[[Property:modification_date|Sun, 14 Feb 2021 04:47:20 GMT]] [[Property:modification_date|Sun, 14 Feb 2021 05:03:11 GMT]]
[[Property:publication_date|Thu, 11 Feb 2021 07:55: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:title|Writing Documentation Filters with EFF, the Eiffel Filter Format]]
[[Property:weight|6]] [[Property:weight|6]]
@@ -166,11 +166,12 @@ A multi-line entry uses the Eiffel convention for string continuations: <code>%<
The following is a replica of the EFF template file as distributed with EiffelStudio v20.11. The following is a replica of the EFF template file as distributed with EiffelStudio v20.11.
Location: <code>$ISE_EIFFEL/studio/filters/format.fil-template</code> <code>
Location: $ISE_EIFFEL/studio/filters/format.fil-template
Timestamp: Timestamp: $Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $
<code>$Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $ $Revision: 92456 $
$Revision: 92456 $</code> </code>
====Generator provided Items==== ====Generator provided Items====
@@ -180,7 +181,7 @@ In every construct, the following items are defined:
<code> <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. $html_meta$ HTML specific. Entire indexing clause defined as meta data.
Example: "<META NAME="keywords" CONTENT="eiffel, O-O">". Example: "<META NAME="keywords" CONTENT="eiffel, O-O">".
$class$ Classname in uppercase. If currently processed file does $class$ Classname in uppercase. If currently processed file does
@@ -233,7 +234,7 @@ class_menu_item |*
menu_item_disabled |* menu_item_disabled |*
The current format. The current format.
class_menu_item_disabled |* class_menu_item_disabled |*
The current format. The current format.
cluster_name |* cluster_name |*
@@ -252,7 +253,7 @@ origin_comment |*
====Major syntactical constructs==== ====Major syntactical constructs====
<code> <code>
class_declaration |* class_declaration |*
Contains entire document. Contains entire document.
HTML Example: <HTML><BODY>*</BODY></HTML> HTML Example: <HTML><BODY>*</BODY></HTML>
@@ -284,190 +285,190 @@ class_end |*
====Eiffel syntax items==== ====Eiffel syntax items====
<code> <code>
features |* features |*
Eiffel feature reference. Symbols: Eiffel feature reference. Symbols:
$feature$ actual feature name of feature in class where it is written. $feature$ actual feature name of feature in class where it is written.
$file$ link to class where feature is written. $file$ link to class where feature is written.
HTML example: <A HREF="$file$#$feature$">*</A> HTML example: <A HREF="$file$#$feature$">*</A>
keyword |* keyword |*
Processed when a keyword is encountered but it is not explicitly specified. Processed when a keyword is encountered but it is not explicitly specified.
keyword_features |* keyword_features |*
Operator keyword or "Precursor" Operator keyword or "Precursor"
If not specified, "keyword" is processed. If not specified, "keyword" is processed.
$file$ and $feature$ are defined, like for "features". $file$ and $feature$ are defined, like for "features".
symbol |* symbol |*
Processed when a symbol is encountered but it is not explicitly specified. Processed when a symbol is encountered but it is not explicitly specified.
symbol_features |* symbol_features |*
Operator symbol. If not specified, "symbol" is processed. Operator symbol. If not specified, "symbol" is processed.
$file$ and $feature$ are defined, like for "features". $file$ and $feature$ are defined, like for "features".
reserved_word |* reserved_word |*
`Result' or `Current'. `Result' or `Current'.
comment |* comment |*
Example. Example.
comment_url |* comment_url |*
A URL in a comment. If not specified, "comment" is processed. A URL in a comment. If not specified, "comment" is processed.
Symbol $file$ contains the URL. Symbol $file$ contains the URL.
string |* string |*
Eiffel literal string. Eiffel literal string.
string_url |* string_url |*
A URL inside an Eiffel string. If not specified, "string" is processed. A URL inside an Eiffel string. If not specified, "string" is processed.
Symbol $file$ contains the URL. Symbol $file$ contains the URL.
quoted |* quoted |*
character |* character |*
number |* number |*
local_symbol |* local_symbol |*
assertion_tag |* assertion_tag |*
indexing_tag |* indexing_tag |*
generic |* generic |*
Formal generic class. Formal generic class.
</code> </code>
====Whitespace processing==== ====Whitespace processing====
<code> <code>
tab |* tab |*
HTML Example: "&nbsp%;&nbsp%;&nbsp%;&nbsp%;". HTML Example: "&nbsp%;&nbsp%;&nbsp%;&nbsp%;".
new_line |* new_line |*
HTML Example: "<BR>". HTML Example: "<BR>".
multiple_spaces |* multiple_spaces |*
In case a sequence of spaces are encountered, this symbol is used for all subsequent spaces. In case a sequence of spaces are encountered, this symbol is used for all subsequent spaces.
HTML Example: "&nbsp%;". HTML Example: "&nbsp%;".
</code> </code>
====Eiffel keywords==== ====Eiffel keywords====
<code> <code>
interface |* interface |*
Appended to keyword "class" in short and flat-short forms. Appended to keyword "class" in short and flat-short forms.
alias |* alias |*
all |* all |*
as |* as |*
check |* check |*
class |* class |*
create |* create |*
debug |* debug |*
deferred |* deferred |*
do |* do |*
else |* else |*
elseif |* elseif |*
end |* end |*
ensure |* ensure |*
expanded |* expanded |*
export |* export |*
external |* external |*
false |* false |*
feature |* feature |*
from |* from |*
frozen |* frozen |*
if |* if |*
indexing |* indexing |*
infix |* infix |*
inherit |* inherit |*
inspect |* inspect |*
invariant |* invariant |*
is |* is |*
like |* like |*
local |* local |*
loop |* loop |*
obsolete |* obsolete |*
old |* old |*
once |* once |*
precursor |* precursor |*
prefix |* prefix |*
redefine |* redefine |*
rename |* rename |*
require |* require |*
rescue |* rescue |*
retry |* retry |*
select |* select |*
separate |* separate |*
strip |* strip |*
then |* then |*
true |* true |*
undefine |* undefine |*
unique |* unique |*
until |* until |*
variant |* variant |*
when |* when |*
Operators: Operators:
and |* and |*
and then |* and then |*
implies |* implies |*
not |* not |*
or |* or |*
or else |* or else |*
xor |* xor |*
</code> </code>
====Eiffel symbols==== ====Eiffel symbols====
<code> <code>
:= |* := |*
: |* : |*
%, |* %, |*
-> |* -> |*
%-- |* %-- |*
$ |* $ |*
. |* . |*
.. |* .. |*
" |* " |*
= |* = |*
! |* ! |*
> |* > |*
>= |* >= |*
<< |* << |*
[ |* [ |*
{ |* { |*
( |* ( |*
< |* < |*
<= |* <= |*
' |* ' |*
>> |* >> |*
] |* ] |*
} |* } |*
) |* ) |*
?= |* ?= |*
; |* ; |*
~ |* ~ |*
Operators: Operators:
+ |* + |*
- |* - |*
%* |* %* |*
/ |* / |*
// |* // |*
\\ |* \\ |*
^ |* ^ |*
/= |* /= |*
</code> </code>
====Obsolete filter constructs==== ====Obsolete filter constructs====
<code> <code>
!! |* !! |*
creation |* creation |*
cluster_declaration |* cluster_declaration |*
cluster_header |* cluster_header |*
</code> </code>