PR# 19582 Project Documentation Profiles

Problem Report Summary
Submitter: rwschlatter
Category: EiffelStudio
Priority: Medium
Date: 2019/09/21
Class: Feature Request
Severity: Non-critical
Number: 19582
Release: 19.05
Confidential: No
Status: Open
Environment: any
Synopsis: Project Documentation Profiles

I have just been overwhelmed by the choice of options when experimenting with the project documentation.

May I suggest that the choice of options are saved under a named option file, where it can be recalled to produce the same structured output again. Currently a new documentation starts fresh over and one needs to remember the prior choices. This would allow to have several types of documentation side-by-side.

Please suggest the target directory within Documentation with the same name as the profile.

If output is a single file, add date and time to the file name to enable multiple versions. For multi-file outputs like html create a new directory with date ad time.

To Reproduce

Problem Report Interactions
From:rwschlatter    Date:2019/09/22    Status: Open    Download   


From:rwschlatter    Date:2019/09/21    Status: Open    Download   
I have begun to study the structure of the Eiffel CMS/ROC application using the generated document rather than working from within the workbench.

I generated the flat forms of the classes.

My annoyance now is that when reading classes the important application stuff gets drowned out by the repetitive listing of features that are inherited from class ANY.

Please add an option to the documenter that features inherited from ANY can be suppressed (possibly with line at top as a reminder).

I don't know if helpful, but a little generalization would include a list of other classes one wishes to ignore at the time of generating documentation.

Of course these options also to be saved in the document profile suggested further up.

From:rwschlatter    Date:2019/09/21    Status: Open    Download   
In addition to me message a few minutes ago, ISE shows up also in the header.

Adding to my suggestions:

The header ought to show the project name in some sort. User definable would be prefered.

I think it would be nice to have the compiler version show up in the footer like "generated by Eiffel version xx.yy".

It would be useful to have date and time stamp on the generated output too.

More general: allow substitution of Eiffel project variables in the text.

And all to be saved in a document profile as suggested further up.


Letting my phantasy run freely I end up with the luxury implementation of a format seen in many text processing applications: header and footers each consisting of three parts, left, cent er and right with matching alignments of left center right.

From:rwschlatter    Date:2019/09/21    Status: Open    Download   
Just generated a documentation (testing) in simple html.

The generated pages show up with a footer of :

-- Generated by ISE Eiffel --
For more details:

For one, I think you want to retire ISE in this context and possible replace it by Eiffel Software.
On the other hand, I am not fond that you force that footer onto project documentation. Technically inclinded readers will now how this was done, others will likely never read a project docu.

But if you think having a footer useful, please make it configurable, keep your company details as default, but let devlopers override it by something about their project and own company.