Opened 5 years ago

Closed 4 years ago

#11782 closed task (fixed)

Convert the Human Interface Guidelines to match the user/api guide style

Reported by: richienyhus Owned by: waddlesplash
Priority: normal Milestone: Unscheduled
Component: Documentation Version: R1/Development
Keywords: Cc:
Blocked By: Blocking:
Has a Patch: no Platform: All


Convert the Human Interface Guidelines to use the user/api guide theme.

Both the Human Interface Guidelines and Haiku Icon Guidelines are just using plan html which does not match the rest of the api guides.

Change History (7)

comment:1 by waddlesplash, 5 years ago

Actually, they're written in Docbook XML. But I have no reasons why we can't just incorporate them into the Haiku Book, are there any reasons why they aren't already? @John, what are your thoughts on this?

comment:2 by pulkomandy, 5 years ago

The Haiku Book is API documentation, while the HIG is not. They have a different purpose and it is a good idea to separate them because it makes it easier to know where to look for information. Want to know how one function is supposed to work? The Haiku Book can answer. Want to know if there is a standard menu label or shortcut for some common action? It's in the HIG.

They have different ways of browsing (you navigate the Haiku Book by kits/classes, the HIG by chapters), different uses, and possibly different target audiences (the HIG is relevant also if you write apps in Yab, IUP, Bethon, or if you are trying to integrate Qt apps or the Qt port with other parts of the system. The HIG is one key to why the system feels smoothly integrated to users. The BeAPI is just one technical solution to achieve this (the other solutions are probably more complex in the current situation, but they exist).

The icon guidelines are targetted to a completely different audience: people drawing icons. They may find the HIG interesting or somewhat relevant, but they almost certainly have no use for the Haiku Book.

So, we should keep them separate.

Back on topic now: indeed they are written in DocBook and it is possible (and not too hard) to change the generated HTML to include the Haiku style. This was already on my unwritten TODO list.

comment:3 by waddlesplash, 5 years ago

That makes sense. While you're at it, can you remove docbook/xslt from the tree? It looks like they're built as host targets so they can compile the docbook to html, so we should just rely on them being preinstalled on the host (this is what we do for Doxygen already).

comment:4 by pulkomandy, 5 years ago

I don't know, I'm not sure how the bot which generates the HIG works and if it relies on the jam targets or not. I don't even know who setup that bot (probably nielx?)

comment:5 by pulkomandy, 5 years ago

Milestone: R1Unscheduled

The HIG isn't part of the R1 milestone. Please try to set the milestone properly when opening new tickets.

comment:6 by waddlesplash, 5 years ago

Owner: changed from nielx to waddlesplash
Status: newassigned

comment:7 by waddlesplash, 4 years ago

Resolution: fixed
Status: assignedclosed

Fixed in hrev50133.

Note: See TracTickets for help on using tickets.