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

At the bottom added title Customization and rewrote the last paragraphs. Added link to Writing Documentation Filters

Browse Source 
Updated wikipage Producing and Exporting Documentation.
	(Signed-off-by:RTH10260).

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2295 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2021-02-12 14:57:41 +00:00
parent 7621a5623e
commit 9e8feb8a33
1 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/20.11/eiffelstudio/Tutorials/producing-and-exporting-documentation.wiki
View File

@@ -1,4 +1,4 @@
[[Property:modification_date|Mon, 08 Feb 2021 02:10:40 GMT]]
[[Property:modification_date|Fri, 12 Feb 2021 14:57:41 GMT]]
[[Property:publication_date|Mon, 08 Feb 2021 02:10:40 GMT]]
[[Property:title|Producing and Exporting Documentation]]
[[Property:weight|-7]]
@@ -15,6 +15,7 @@ EiffelStudio provides unique facilities to make such distributed development pos
EiffelStudio's documentation generation satisfies all these requirements.
==Documentation filters==
Let's see how documentation works by starting to generate it for our Guided Tour system -- which really means for EiffelBase, since that's what it mostly consists of. The HTML result is available as part of the present documentation (we'll tell you where in just a minute), so you don't have to regenerate it unless you want to. Indeed we'll show you when to click <code>Cancel</code> if you are happy with the pre-generated version. But let's get started anyway to understand the principles and possibilities.
@@ -150,12 +151,14 @@ The top row of hyperlinks now includes class formats corresponding to those we d
We'll stop this brief review here but you may continue browsing through the HTML pages if you like. Note how closely the appearance of the class texts, flat forms, contract forms, diagrams and other forms of documentation matches the corresponding formats under EiffelStudio.
Although we suggest staying with the standard, you can easily change any convention that doesn't match your own preferences:
* For the EiffelStudio appearance, use <code lang=text>Tools --> Preferences</code>.
* For the HTML appearance, if you know about Cascading Style Sheets (CSS) for HTML, edit the style sheet <code>default.css</code>. You will find this file in the generated documentation directory; alternatively, to ensure the changes are applicable to the generated documentation of all future projects, edit <code>defaults.css</code> in the directory after backing it up. For more profound changes in the structure of the generated HTML, you may also backup and edit the Eiffel Filter Format file <code>html-stylesheet.fil</code> in the same directory. EFF is described in the [[APPENDIX: WRITING DOCUMENTATION FILTERS WITH EFF, THE EIFFEL FILTER FORMAT|Appendix]] .
<code>
$ISE_EIFFEL/studio/filters</code>
==Customization==
As shown above in section [[#Documentation_filters|Documentation Filters]] the generation mechanisms can produce a number of output formats. The format definition files have an extension <code>.fil</code> and are stored in the installation path <code>\studio\filters\format.fil-template</code>
Although we suggest staying with the standard, you can easily add or change any definition that doesn't match your own preferences.
The format of the filter files is described in [[/doc/eiffelstudio/Writing_Documentation_Filters_with_EFF%2C_the_Eiffel_Filter_Format|Writing Documentation Filters with EFF]] .
The documentation generation mechanisms, using HTML or other formats, let you publish your designs, at the level of detail you desire, on an Intranet, the Internet, or as part of documents you release. They are an important part of the power of EiffelStudio for quality software development.
{{Note|to adapt the presentation format within the EiffelStudio editors, use Tools --> Preferences.}}