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 0b7908c3..e0a6cdb7 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 Filters with EFF]] -[[Property:modification_date|Sun, 14 Feb 2021 06:05:30 GMT]] +[[Property:modification_date|Wed, 17 Feb 2021 22:07:19 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]] @@ -97,6 +97,24 @@ When you choose to generate documentation, EiffelStudio will ask you to select a To make a new filter available to yourself and other users of this installation, just add the corresponding file some_name.fil to this directory. Make sure to choose the appropriate name, since this is what the menu of available filters will display. +==Output generated== + +The output will be placed in the directory specified in the "Project>Generate Documentation" dialog of EiffelStudio. + +The output type is determined by the suffix construct in the filter file. + +Output type 1 - suffix is HTML: +* HTML formatted web pages with file extension .HTML +* with a copy of the stylesheet default.css copied to the Documentation directory +* with a generated menu goto.html placed into the Documentation directory with submenu directories as required +* any other supporting files (stylesheets, javascript) must manually be placed in the Documentation directory +* the filter must define a major construct, eg class_declaration, cluster_declaration, to contain a complete HTML skeleton of a webpage + +Output type 2 - suffix is any other: +* if suffix is missing the output will produced with a .TXT file extension +* if suffix is defined the output will produced with the given file extension +* as needed the filter must define a major construct, eg class_declaration, cluster_declaration, to contain a complete skeleton for the desired output target + ==Filter basics== An EFF filter follows a very simple structure. As with all other Eiffel-related notations any line or part of a line beginning with two consecutive dashes -- is a comment, except if it immediately follows a percent sign since, as will be seen below, - %- is used to denote an Eiffel comment in the class text. Blank lines are also permitted. Comments and blank lines carry no semantic value. @@ -306,7 +324,8 @@ features |* HTML example: * 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 |* Operator keyword or "Precursor" @@ -314,7 +333,8 @@ keyword_features |* $file$ and $feature$ are defined, like for "features". 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 |* Operator symbol. If not specified, "symbol" is processed.