bugLiberty Eiffel - Bugs: bug #48153, Eiffeldoc output is not readable...

 
 

bug #48153: Eiffeldoc output is not readable without JS

Submitted by:  None
Submitted on:  Mon 06 Jun 2016 07:17:47 PM UTC  
 
Category:  Liberty tools Severity:  4 - Important
Priority:  7 - High Status:  None
Assigned to:  None Open/Closed:  Open
Release:  None Fixed Release:  None
Planned Release:  curtiss

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Sat 23 Jul 2016 12:45:25 PM UTC, comment #4:

Is this a bug, really? I propose to close this ticket and (if need be) re-open it as a task, not a bug...

Hans Zwakenberg <hzwakenberg>
Project Administrator
Thu 09 Jun 2016 06:42:36 PM UTC, comment #3:

ok, I fully agree. Anyhow, the HTML is so strange, I think we need a full redesign of eiffeldoc.

Maybe you or someone experienced with HTML can propose something. The most tricky thing is in my eyes to have a clean way of to select the "point of view" - i.e. show only those features, exported to a specific class hierarchy. -> without a dedicated html file for each point of view.

Raphael Mack <ramack>
Project Administrator
Tue 07 Jun 2016 07:55:04 AM UTC, comment #2:

Sorry, it is mentioned in the help so I didn't think it would need much detail.

https://www.w3.org/wiki/Graceful_degradation_versus_progressive_enhancement#Graceful_degradation_and_progressive_enhancement_in_a_nutshell

se doc -h includes "If a proper JavaScript file is not given with the -js flag, the 'navigation' will not be possible (except for browser which are not CSS compliant)."

In any browser that doesn't support JavaScript, or has it disabled, but does support CSS then the documentation is mostly useless without user intervention to disable or alter the site's CSS.

E.g., http://doc.liberty-eiffel.org/api/libraries/index.html only displays a list of clusters with non-functioning links and provides no access to the classes because they're hidden with CSS.

For browsing documentation I primarily use either dillo or lynx, neither of which support JS. It works in lynx because it doesn't support CSS but not in dillo which does support CSS so I have to disable the style sheet for it to work.

Also, when using Firefox I use the popular NoScript addon and having to add a whitelist exception or user style sheet seems unnecessary.

I've never come across any other API documentation that requires JS, CSS or both for basic functionality. It doesn't seem desirable and would appear to only require a simple change to default to showing the classes when JS is disabled.

Anonymous
Mon 06 Jun 2016 07:56:29 PM UTC, comment #1:

Thanks for this entry, but to be honest, I don't get the point.

What do you mean?
What is the effect you observe and what do you expect?
Which browser do you use?
Can you attach a screenshot?

Raphael Mack <ramack>
Project Administrator
Mon 06 Jun 2016 07:17:47 PM UTC, original submission:

Provide basic functionality in all browsers without requiring user intervention.

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by hzwakenberg (Posted a comment)
  • -email is unavailable- added by ramack (Posted a comment)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2016-07-23 ramack Severity3 - Normal => 4 - Important
        Priority5 - Normal => 7 - High
    2016-06-09 ramack SummaryEiffeldoc functionality should 'degrade gracefully' => Eiffeldoc output is not readable without JS

    Back to the top


    Powered by Savane 3.4