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

work in progress: more table stuff, minor editing at The Asterisk

Browse Source 
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@2301 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-13 04:49:50 +00:00
parent 1879da502a
commit abc14ec66a
1 changed files with 6 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
[[Property:link_title|Writing Documentation FiltersFilters with EFF, the Eiffel Filter Format]]
[[Property:modification_date|Sat, 13 Feb 2021 03:10:13 GMT]]
[[Property:modification_date|Sat, 13 Feb 2021 04:49:50 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]]
@@ -60,19 +60,6 @@ Note that in practice the best way to write an EFF filter is usually not from sc
|-
| XML || xml || xml.fil ||
|}
{| class="wikitable" style="width: 60%;"
|+ '''''Variants'''''
|-
! Documentation<br />Type !! Filter File !! Remarks
|-
| HTML ||html-classic.fil || web page old version plain
|-
| HTML || documentation.fil || web page with default.css
|-
| HTML ||html-stylesheet.fil || web page with default.css
|-
|}
{| class="wikitable" style="width: 60%;"
|+ '''''Assisting'''''
|-
@@ -110,18 +97,14 @@ For readability, there may be any number of blanks or tabs between the <code>Con
==The asterisk==
In the <code>Replacement</code> part, you may use the symbol <code>*</code> (asterisk) to denote the construct specimen itself. So for example the entry
<code>Feature_clause | %N%N*%N%N</code>
In the <code>Replacement</code> part, you may use the symbol <code>*</code> (asterisk) to denote the construct specimen itself.
specifies the following formatting for any <code>Feature_clause</code>: two successive blank lines (expressed as <code>%N</code>, New Line, a convention taken from Eiffel); the feature clause itself; two blank lines.
So for example the entry <code>Feature_clause | %N%N*%N%N</code> specifies the following formatting for any <code>Feature_clause</code>:
two successive blank lines (expressed as <code>%N</code>, New Line); the feature clause itself; two blank lines.
Similarly, in an HTML format, the entry
<code>External |<B> * </B></code>
Similarly, in an HTML format, the entry <code>External |<B> * </B></code> means that the Eiffel keyword <code>external</code> must appear in the filtered form immediately preceded by <code><B></code>, the HTML code for switching to boldface, and immediately followed by <code></B></code>, the code for reverting to the previous setup.
means that the Eiffel keyword <code>external</code> must appear in the filtered form immediately preceded by <code><B></code>, the HTML code for switching to boldface, and immediately followed by <code></B></code>, the code for reverting to the previous setup. Here you can also write the right-hand side without the asterisks, as <code><B>external</B></code>. If, however, all keywords are to use boldface, it is preferable to write a single entry
<code>Keyword |<B> * </B></code>
which, thanks to the asterisk, will govern all construct specimens of the <code>Keyword</code> category. You can still override this specification for an individual keyword by including a specific entry for it.
Here you can also write the right-hand side without the asterisks, as <code><B>external</B></code>. If, however, all keywords are to use boldface, it is preferable to write a single entry <code>Keyword |<B> * </B></code> which, thanks to the asterisk, will govern all construct specimens of the <code>Keyword</code> category. You can still override this specification for an individual keyword by including a specific entry for it.
==Constructs==