Book a Demo

Author Topic: User guide API documentation not navigable  (Read 6093 times)

Uffe

  • EA Practitioner
  • ***
  • Posts: 1859
  • Karma: +133/-14
  • Flutes: 1; Clarinets: 1; Saxes: 5 and counting
    • View Profile
User guide API documentation not navigable
« on: January 31, 2018, 03:17:17 am »
Hi all,


The API documentation in the user guide cannot be navigated to find what you need.

Starting from the first page, I can navigate to Automation, then to Object Model, then to Reference, which has links to pages for the different packages.
Then what? Well, let's see.

Repository Package => "Learn more" => Repository Class. Well, OK -- but what about all the other classes? Fail.
Element Package => Just a class diagram, no links. Fail.
Element Features Package => Just a class diagram, no links. Fail.
Connector Package => Just a class diagram, no links. Fail.
Diagram Package => Just a class diagram, no links. Fail.
Project Interface Package => Just a class diagram, no links. Fail.
Document Generator Interface Package => "Learn more" => DocumentGenerator Class. Alright. And look, there's the Project class!
Mail Interface Package => "Learn more" => MailInterface Class. OK.

And if I'm looking for the Simulation Package I'm poop out of luck, 'cos that's not even listed on the Reference page. Are there other packages missing? Who knows?

Prev/Next buttons, you say? These packages have got dozens of classes in them. Left-to-right navigation is -- no. Just no.

Look, I understand the desire to move from the installed help file to an on-line web format but you can't just take a tree-structured bunch of help pages, flatten them out and call it good. You've got to make sure the new structure can actually be navigated, and that means every class has to be linked from its parent package's page.

It's time to fix this.


/Uffe
My theories are always correct, just apply them to the right reality.

Eve

  • EA Administrator
  • EA Guru
  • *****
  • Posts: 8110
  • Karma: +119/-20
    • View Profile
Re: User guide API documentation not navigable
« Reply #1 on: January 31, 2018, 08:29:06 am »
Try the dropdown for child (or sibling when there are no children) topics.

qwerty

  • EA Guru
  • *****
  • Posts: 13584
  • Karma: +397/-301
  • I'm no guru at all
    • View Profile
Re: User guide API documentation not navigable
« Reply #2 on: January 31, 2018, 10:21:27 am »
When I'm on the road at dawn and see someone flash the lights I think WTF? When I see a second one doing that I start thinking. And if my lights are not already turned on (which I might have realized now) I start thinking about having a look after my lights soon. Sometimes it's not all those idiots outside being wrong  :-X

To be precise here: this is meant towards Sparx, not Uffe!

q.
« Last Edit: January 31, 2018, 10:23:01 am by qwerty »

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: User guide API documentation not navigable
« Reply #3 on: January 31, 2018, 04:32:16 pm »
Yes it is a bit awkward.
You repeatedly have to press the "Topics" button (called "dropdown" by Simon but doesn't look like a dropdown) to navigate deeper into the topics tree.

Geert


Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8626
  • Karma: +259/-129
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: User guide API documentation not navigable
« Reply #4 on: January 31, 2018, 05:56:39 pm »
Yes it is a bit awkward.
You repeatedly have to press the "Topics" button (called "dropdown" by Simon but doesn't look like a dropdown) to navigate deeper into the topics tree.

Geert
Yes, I came to the same conclusion a few weeks ago.  I keep a copy of the last .chm file around for look-ups on older topics, then once I've got the right page, I try to get to the latest version.

I DO miss a lot of the functionality of the old chm file

Paolo
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

Uffe

  • EA Practitioner
  • ***
  • Posts: 1859
  • Karma: +133/-14
  • Flutes: 1; Clarinets: 1; Saxes: 5 and counting
    • View Profile
Re: User guide API documentation not navigable
« Reply #5 on: January 31, 2018, 10:52:43 pm »
ErrrmrGrrrd. So that's actually a menu. Well I never.  :-[

You repeatedly have to press the "Topics" button (called "dropdown" by Simon but doesn't look like a dropdown) to navigate deeper into the topics tree.
Yes, I came to the same conclusion a few weeks ago.  I keep a copy of the last .chm file around for look-ups on older topics, then once I've got the right page, I try to get to the latest version.

I DO miss a lot of the functionality of the old chm file

Paolo

Yeah. For a while I actually compiled CHM files from the downloaded HTML myself, but in order for the resulting structure to be navigable I had to do a lot of manual fiddling and in the end, given the pace of releases, it's just not worth the effort.

Anyway, thanks guys. Learned something. :)

/Uffe
My theories are always correct, just apply them to the right reality.