This is a follow up article to the introduction of Eiffel-View 1.0, a tool for publishing Eiffel repositories on a website. It offers a superior browsing experience to either Github or Sourceforge.
The site-map home page now has a hyperlinked contents of the major repository repository sections.
Configuration file format has been changed where possible to use element attributes in preference to text elements. See example Eiffel-Loop/doc-config/config.pyx. The basic configuration is only 15 lines.
Source Tree Descriptions
It is now possible to add descriptions for each source tree that will appear in the site-map home page. Eiffel-View markdown formatting can use for formatting the text. The descriptions
are specified in the publishing configuration file. As for example:
Longer descriptions can be specified in a separate file with a
The description field can be omitted altogether if the name of the .emd file matches the last step of the dir path as in this case.
Abbreviated Directory Contents
Version 1.1 allows you to keep the amount of text in the directory contents to a minimum. Only the description is listed after the class name, and for extended descriptions, the developer is encouraged to split into several note fields which will then appear in the source code page. Also for library directories the list of client examples now only appears in the source page.
Further Information Cue
If a class source page contains other information besides the description, the reader is made aware of this in the directory contents page by the inclusion of a header Further Information which provides a list of other note fields and the existence of a client example listing. For example: class-index.html#EIFFEL_FEATURE_EDITOR_APP
Note Field Parsing
Version 1.1 has better note field parsing support.
Version 1.0 could only read the description note field from the Eiffel source. But now it is possible to specify a list of note field names in the configuration file, and the entire Eiffel source code will be scanned looking for these fields. As for example:
Legacy String Syntax Support
Eiffel-Viewer can now parse the split-line string syntax found in many ISE classes, as for example:
Enhanced Source Pages
In version 1.1 source pages now have the description and selected notes rendered in html. There is also a handy link at the top of the page with will skip all the notes and show the start of the class definition source code. Take a look at class EIFFEL_FEATURE_EDITOR_APP as an example.
The very first link in the page, is a way to bookmark the class where it appears in the source contents page.
Eiffel-View now has support for both ordered and unordered lists
The markdown for bullet points is an asterisk at the start of a line followed by a space. Nested list are not supported.
The markdown for a numbered list is an natural number followed by a dot followed by a space. Nested lists are not supported.
Double single quotes on either side of a
Eiffel-view will automatically generate the contents of the site-map page translated into Github markdown. The file is named
Download the latest version of el_toolkit for Ubuntu 14.04 or Linux Mint 17.x here.