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 0b68e5b3..67ecac89 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 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: -$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: "". +$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. +$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: "../../../../" ====Properties==== -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. ====Basic Text==== -basic |* - Basic text +basic |* + Basic text ====Hyperlinking items==== -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: * +tooltip |* + Text contained within this construct requests a tooltip. + Symbol: $tooltip$. + HTML Example: * -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 -====xxx==== +====Major syntactical constructs==== +class_declaration |* + Contains entire document. + HTML Example: * + +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: * + +invariant_clause |* + +class_end |* -====xxx==== +====Eiffel syntax items==== +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: * + +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. -====xxx==== +====Whitespace processing==== +tab |* + HTML Example: " %; %; %; %;". + +new_line |* + HTML Example: "
". + +multiple_spaces |* + In case a sequence of spaces are encountered, this symbol is used for all subsequent spaces. + HTML Example: " %;". + + +====Eiffel keywords==== + + +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 |* + + +====Eiffel symbols==== + + +:= |* +: |* +%, |* +-> |* +%-- |* +$ |* +. |* +.. |* +" |* += |* +! |* +> |* +>= |* +<< |* +[ |* +{ |* +( |* +< |* +<= |* +' |* +>> |* +] |* +} |* +) |* +?= |* +; |* +~ |* + +Operators: + ++ |* +- |* +%* |* +/ |* +// |* +\\ |* +^ |* +/= |* + + +====Obsolete filter constructs==== + + +!! |* +creation |* +cluster_declaration |* +cluster_header |*