diff --git a/documentation/20.11/eiffelstudio/Tutorials/appendix-writing-documentation-filters-eff-eiffel-filter-format.wiki b/documentation/20.11/eiffelstudio/Tutorials/appendix-writing-documentation-filters-eff-eiffel-filter-format.wiki index 0b2e4411..e929dfbb 100644 --- a/documentation/20.11/eiffelstudio/Tutorials/appendix-writing-documentation-filters-eff-eiffel-filter-format.wiki +++ b/documentation/20.11/eiffelstudio/Tutorials/appendix-writing-documentation-filters-eff-eiffel-filter-format.wiki @@ -1,5 +1,5 @@ [[Property:link_title|Writing Documentation FiltersFilters with EFF, the Eiffel Filter Format]] -[[Property:modification_date|Sat, 13 Feb 2021 04:49:50 GMT]] +[[Property:modification_date|Sat, 13 Feb 2021 06:28:37 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]] @@ -107,39 +107,20 @@ Similarly, in an HTML format, the entry External | * means Here you can also write the right-hand side without the asterisks, as external. If, however, all keywords are to use boldface, it is preferable to write a single entry Keyword | * which, thanks to the asterisk, will govern all construct specimens of the Keyword category. You can still override this specification for an individual keyword by including a specific entry for it. ==Constructs== +{{UnderConstruction|making it match the latest definitions in distribution}} -The following general syntactic constructs may appear as the left-hand side, Construct, of an entry: - -Class_declaration -Class_end -Class_header -Class_name -Comment -Creators -Escape -Feature_clause -Feature_declaration -Features -Formal_generics -Indexing_clause -Inheritance -Invariant_clause -Keyword -New_line -Obsolete_clause -Suffix -Symbol -Tab - +The general syntactic constructs may appear as the left-hand side, Construct, of an entry: -Most of these denote Eiffel constructs as they appear in the official language reference, the book [[Eiffel: The Language]] . Since the Eiffel construct names Feature, Invariant and Obsolete are also keywords and EFF, like Eiffel, is case-insensitive, the EFF construct names use the suffix _clause, for example Feature_clause. +Most EFF constructs denote Eiffel constructs as they appear in the official language reference, the book [[Eiffel: The Language]] respective in the more recent [[/doc/eiffel/ECMA_Standard_367|ECMA Standard]]. + +Since certain construct names Feature, Invariant and Obsolete are also Eiffel keywords and EFF, like Eiffel, is case-insensitive, the EFF construct names use the suffix _clause, for example Feature_clause. The constructs corresponding to syntactic constructs are self-explanatory. The others are: * Class_end, denoting the final end of a class text. -* Keyword, denoting any Eiffel keyword among those listed in boldface in the corresponding appendix in [[Eiffel: The Language]] +* Keyword, denoting any Eiffel keyword among those listed in boldface in the the official language reference. * New_line, denoting any passage to a new line in the class text. * Suffix, used to introduce the file extension for the generated documentation files. If you don't specify this, EiffelStudio will use the filter's name as extension. -* Symbol, denoting any of the Eiffel symbols listed in the corresponding appendix of [[Eiffel: The Language]] . +* Symbol, denoting any of the Eiffel symbols listed in the official language reference. * Escape, to protect special characters of the external tool, as explained below. * Tab, denoting any tab character appearing in the class text. @@ -180,3 +161,34 @@ If c is not one of the characters for which special conventions hav A multi-line entry uses the Eiffel convention for string continuations: % at the end of a line to signal that there is a continuation; a continuation line begins with zero or more spaces and tabs followed by a % ; the characters after the % are the continuation of the string. +==The EFF Template File== +{{UnderConstruction|making it match the latest definitions in distribution}} + +The following is a replica of the EFF template file as distributed with EiffelStudio v20.11. + +Location: $ISE_EIFFEL/studio/filters/format.fil-template + +Timestamp: +--! $Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $ +--! $Revision: 92456 $ + +===Generator provided Items=== + +Several extra items may be defined and accessed through: $item$. + +In every construct, the following items are defined: + +$generator$ "ISE EiffelStudio version x.x.x" + +$html_meta$ HTML specific. Entire indexing clause defined as meta data. + Example: "". + +$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". + +$root$ Relative base directory of generated documentation. + Example: "../../../../" + \ No newline at end of file