[haiku-bugs] Re: [Haiku] #11782: Convert the Human Interface Guidelines to match the user/api guide style
- From: "pulkomandy" <trac@xxxxxxxxxxxx>
- Date: Mon, 26 Jan 2015 07:51:01 -0000
#11782: Convert the Human Interface Guidelines to match the user/api guide style
-----------------------------+----------------------------
Reporter: richienyhus | Owner: nielx
Type: task | Status: new
Priority: normal | Milestone: R1
Component: Documentation | Version: R1/Development
Resolution: | Keywords:
Blocked By: | Blocking:
Has a Patch: 0 | Platform: All
-----------------------------+----------------------------
Comment (by pulkomandy):
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.
--
Ticket URL: <https://dev.haiku-os.org/ticket/11782#comment:2>
Haiku <https://dev.haiku-os.org>
Haiku - the operating system.
Other related posts:
