mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 15:22:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added small section re output generated

Browse Source 
small visual enhancement in template sample
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@2317 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-17 22:07:19 +00:00
parent 4dd46b755b
commit a4ab187847
1 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
[[Property:link_title|Writing Filters with EFF]] [[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: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]]
@@ -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 <code>some_name.fil</code> to this directory. Make sure to choose the appropriate <code>name</code>, since this is what the menu of available filters will display. To make a new filter available to yourself and other users of this installation, just add the corresponding file <code>some_name.fil</code> to this directory. Make sure to choose the appropriate <code>name</code>, 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 <code>suffix</code> construct in the filter file.
Output type 1 - <code>suffix</code> is HTML:
* HTML formatted web pages with file extension <code>.HTML</code>
* with a copy of the stylesheet <code>default.css</code> copied to the Documentation directory
* with a generated menu <code>goto.html</code> 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 <code>class_declaration</code>, <code>cluster_declaration</code>, to contain a complete HTML skeleton of a webpage
Output type 2 - <code>suffix</code> is any other:
* if <code>suffix</code> is missing the output will produced with a <code>.TXT</code> file extension
* if <code>suffix</code> is defined the output will produced with the given file extension
* as needed the filter must define a major construct, eg <code>class_declaration</code>, <code>cluster_declaration</code>, to contain a complete skeleton for the desired output target
==Filter basics== ==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 <code>--</code> is a comment, except if it immediately follows a percent sign since, as will be seen below, <code>- %-</code> is used to denote an Eiffel comment in the class text. Blank lines are also permitted. Comments and blank lines carry no semantic value. 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 <code>--</code> is a comment, except if it immediately follows a percent sign since, as will be seen below, <code>- %-</code> 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: <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"
@@ -314,7 +333,8 @@ keyword_features |*
$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.