From 91dc21ecf16cded4e0928aa8693e168f7dfea6f2 Mon Sep 17 00:00:00 2001 From: eiffel-org Date: Sun, 14 Feb 2021 05:57:28 +0000 Subject: [PATCH] work in progress 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@2309 abb3cda0-5349-4a8f-a601-0c33ac3a8c38 --- ...tion-filters-eff-eiffel-filter-format.wiki | 40 +++++++++++-------- 1 file changed, 24 insertions(+), 16 deletions(-) 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 e23c980a..d60dce52 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 FiltersFilters with EFF]] -[[Property:modification_date|Sun, 14 Feb 2021 05:24:06 GMT]] +[[Property:modification_date|Sun, 14 Feb 2021 05:57:28 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]] @@ -17,6 +17,8 @@ If you have a favorite format that you'd like EiffelStudio to use for producing Note that in practice the best way to write an EFF filter is usually not from scratch, but by copying an existing filter -- one that seems closest to your needs -- and adapting the copy. +---- + ==Available Standard Filters== {| class="wikitable" @@ -87,6 +89,8 @@ Note that in practice the best way to write an EFF filter is usually not from sc |- |} +---- + ==Where to put filters== When you choose to generate documentation, EiffelStudio will ask you to select a filter from a list it obtains by looking up the files of extension .fil in the directory $ISE_EIFFEL/studio/filters @@ -170,16 +174,18 @@ 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 + +Location: $ISE_EIFFEL/studio/filters/format.fil-template -Timestamp: $Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $ - $Revision: 92456 $ +Timestamp: $Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $ + $Revision: 92456 $ ====Generator provided Items==== @@ -187,7 +193,7 @@ Timestamp: $Date: 2013-04-18 20:30:43 +0000 (Thu, 18 Apr 2013) $ 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" $html_meta$ HTML specific. Entire indexing clause defined as meta data. @@ -205,7 +211,7 @@ $root$ Relative base directory of generated documentation. ====Properties==== - + suffix |html Used to specify suffix used for this format. Examples: html, txt, ps, e, etc. @@ -218,14 +224,14 @@ file_separator |/ ====Basic Text==== - + basic |* Basic text ====Hyperlinking items==== - + menu_bar |* Contains the different menu items. @@ -261,7 +267,7 @@ origin_comment |* ====Major syntactical constructs==== - + class_declaration |* Contains entire document. HTML Example: * @@ -293,7 +299,7 @@ class_end |* ====Eiffel syntax items==== - + features |* Eiffel feature reference. Symbols: $feature$ actual feature name of feature in class where it is written. @@ -350,7 +356,7 @@ generic |* ====Whitespace processing==== - + tab |* HTML Example: " %; %; %; %;". @@ -364,7 +370,7 @@ multiple_spaces |* ====Eiffel keywords==== - + interface |* Appended to keyword "class" in short and flat-short forms. @@ -432,7 +438,7 @@ xor |* ====Eiffel symbols==== - + := |* : |* %, |* @@ -475,9 +481,11 @@ Operators: ====Obsolete filter constructs==== - + !! |* creation |* cluster_declaration |* cluster_header |* + +----