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

work in progress intermediate save

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@2318 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-22 12:13:07 +00:00
parent a4ab187847
commit b95d5f7ce8
1 changed files with 50 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
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|Wed, 17 Feb 2021 22:07:19 GMT]] [[Property:modification_date|Mon, 22 Feb 2021 12:13:07 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]]
@@ -191,7 +191,55 @@ If <code>c</code> is not one of the characters for which special conventions hav
A multi-line entry uses the Eiffel convention for string continuations: <code>%</code> 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 <code>%</code> ; the characters after the <code>%</code> are the continuation of the string. A multi-line entry uses the Eiffel convention for string continuations: <code>%</code> 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 <code>%</code> ; the characters after the <code>%</code> are the continuation of the string.
---- ==Sample page encoding==
We show sample code taken from existing filter files to demonstrate the basic structure for the skeleton needed for visual presentation.
Note in both examples the position of the <code>*</code>place holder that will contain the expanded page body for the referenced construct.
=== HTML webpages===
To replace the <code>default.css</code> copied into your Documentation directory, to write your own stylesheet based on it and save under a different name. Important: chose a different name or EiffelStudio will overwrite it. Add any scripting files to the Documentation directory if required. Font choice is of course also a user option. Note the generated <code>goto.html</code> file (not a standalone webpage) that contains the navigation thru the generated webpages and is expected to be included by the page skeleton. Replace and add any required inclusion links into the <code>HEAD</code> section of the webpage.
<code lang=text>
class_declaration |%
%<!DOCTYPE html>%N%
%<html>%N%
%<head>%N%
%<meta name="generator" content="$generator$">%N%
%$html_meta$%
%<meta name="viewport" content="width=device-width%, initial-scale=1.0">%N%
%<link href="https://fonts.googleapis.com/css?family=PT+Sans" rel="stylesheet">%N%
%<title>$title$<\/title>%N%
%<link rel="stylesheet" href="$root$default.css" type="text/css">%N%
%<script type="text/javascript" src="$root$goto.html"><\/script>%N%
%<\/head>%N%
%<body>%N%
%<pre>*</pre>%N%
%<p style="text-align:center;">Generated by <a href="http://www.eiffel.com">ISE EiffelStudio<\/a><\/p>%N%
%<\/body>%N%
%<\/html>%N
</code>
===for printing===
Here a sample coding for RTF formatted output, to be run thru some comaptible word processor for pretty printing.
<code lang=text>
Cluster_declaration, Class_declaration |%
%{\rtf1\ansi\ansicpg1252\deflang1033{\fonttbl{\f0\fscript\fcharset0 Courier;}}%
%{\colortbl ;\red0\green0\blue0;\red255\green255\blue255;\red128\green0\blue0;%
%\red0\green0\blue255;\red0\green128\blue0;\red0\green0\blue128;}%N%
%{\cf3\f0\fs16 {\tab}{\tab}{\tab}%-%- Automatic generation produced by ISE Eiffel %-%-%N%
%{\line}%N%
%{*}%N%
%{\line}%N%
%{\cf3 {\tab}{\tab}{\tab}%-%- Generated by ISE Eiffel %-%-}%N%
%{\line}%N%
%{\cf3{\tab}{\tab}{\tab}%-%- For more details: http://www.eiffel.com %-%-}%N%
%}}%N
</code>
==The EFF Template File== ==The EFF Template File==