SFML community forums
General => General discussions => Topic started by: Hiura on July 01, 2013, 06:56:48 pm
-
Hi !
Mac OS X users might already know Dash (http://kapeli.com/dash), a very nice application to browse a lot of documentations offline. Zeal (http://zealdocs.org/) is inspired by Dash and can run on Linux and Windows.
Today I'm happy to annonce that SFML documentation is now available for both doc browsers! :)
Dash
If you already have Dash installed on your machine, simply add SFML docset by opening this link:
dash-feed://http%3A%2F%2Fwww.sfml-dev.org%2Fdownload%2Fdash%2F2.0%2FSFML.xml
If you would like to see SFML part of the official docset list, please request it to here (http://kapeli.com/contact).
Zeal
Zeal doesn't support doc feed like Dash does. So you have to download this archive (http://www.sfml-dev.org/download/dash/2.0/sfml.docset.tgz) and extract it to $HOME/.local/share/zeal/docsets/ or C:\Users\[your username]\AppData\Local\zeal\docsets\.
Now you have no more excuse not to read the documentation! ;D
-
Sounds interesting, I do not knows these programs but it should be better than the HTML doc I've got in local.
Will the archive be updated automatically with new versions of SFML or corrections ?
-
With Dash, yes, it will automatically updated.
I don't know if Zeal has such feature though. But a manual update won't be hard anyway.
-
I've put the doc under a "2.0" folder, assuming that each version would have its own documentation. If the same link is meant to be used for all versions, should I remove that "2.0" from the path?
-
No, it's good like that I think because the xml file cannot contain multiple versions. So we can use it to do minor updates (e.g., typos) but when 2.x is released we would need (or at least it would be cool) to let the user choose if he wants to upgrade his doc or not.
We could then add a general xml for SFML version "2" (not "2.0" or "2.3" for example) that is always the last version of SFML 2.x.