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

work in progress - added table of standard filter files

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@2298 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-12 23:49:07 +00:00
parent 6d8ac0f074
commit 44859c3c0a
1 changed files with 75 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
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|Fri, 12 Feb 2021 21:00:35 GMT]]
[[Property:modification_date|Fri, 12 Feb 2021 23:49:07 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,80 @@ 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==
{{UnderConstruction|Tables are work in progress}}
{| class="wikitable"
|+ ''Filter Files Overview''
|-
! Documentation<br />Type !! Generated File<br />Extension !! Filter File !! Remarks
|-
| ASCII || txt || ASCII.fil || Plain text
|-
| Build || ? || build.fil || EiffelBuild - possibly outdated, around year 2000
|-
| Cayenne|| cj || cayenne.fil || Cayenne Software as of Aug. 1998 Sterling Software, Inc. (?)
|-
| COM || ? || com.fil || Microsoft COM definitions
|-
| Cool Jex || cj || cool_jex.fil || UML modelling by IBM Rational Software (2008, formerly Telelogic March 2000, formerly Sterling Software )
|-
| Eiffel || e || eiffel.fil || replicates Eiffel source
|-
| HTML || html || html.fil || Web page simple formatting with tags
|-
| 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
|-
| Index || index || index.fil || source file names for inclusion into web pages
|-
| MML || mml || MML.fil || Adobe FrameMaker
|-
| PostScript || ps || PostScript.fil || Printer ready
|-
| RTF || rtf || RTF.fil || Rich Text Format for Word Processors
|-
| TeX 1|| tex || TeX1.fil || *ix printing, requires `cmbxti10' font
|-
| TeX 2|| tex || TeX2.fil || *ix printing
|-
| Troff || troff || troff.fil || *ix printing
|-
| XML || xml || xml.fil ||
|}
{| class="wikitable"
|+ ''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"
|+ ''Assisting''
|-
! Documentation<br />Type !! File !! Remarks
|-
| HTML ||default.css || default web page formatting
|-
|}
{| class="wikitable"
|+ ''Special''
|-
! Documentation<br />Type !! File !! Remarks
|-
| EFF Formatting || format.fil-template || Listing of recognized tags
|-
|}
==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 <code>.fil</code> in the directory <code>$ISE_EIFFEL/studio/filters</code>