Solarus Forum

Solarus => Development => Topic started by: santiago_itzcoatl on March 10, 2018, 05:38:30 pm

Title: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: santiago_itzcoatl on March 10, 2018, 05:38:30 pm
 :)

Hi everybody, I just did a Dash Docset for anyone using Dash on OSX.
If you don't know Dash, it's a great tool for search and organise all of your API's documentation.

It's configurated with all the methods, functions and events, as well as a category tree structure following the order in the official documentation.
I will update the Docset to follow the latest versions.

(http://santiagoitzcoatl.net/img/solarus/capture_002.png)


The Docset can be downloaded directly from:
https://github.com/santiagoitzcoatl/Dash-User-Contributions/tree/master/docsets/solarus (https://github.com/santiagoitzcoatl/Dash-User-Contributions/tree/master/docsets/solarus)

Mirror:
http://santiagoitzcoatl.net/Solarus/ (http://santiagoitzcoatl.net/Solarus/)

About Dash:
https://kapeli.com/dash (https://kapeli.com/dash)

A similar documentation browser for Linux and Windows that could use the same Docset
https://zealdocs.org/ (https://zealdocs.org/)



Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: Neovyse on April 01, 2018, 12:57:46 am
Oh yes awesome! Thank you!

For those who use Windows, there is the equivalent named Zeal!
Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: santiago_itzcoatl on April 02, 2018, 03:32:22 pm

 :)
Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: Neovyse on April 05, 2018, 02:25:22 pm
Do you know how to get it into the official list (so we can download Solarus docset in Dash/Zeal) ?
Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: santiago_itzcoatl on April 11, 2018, 06:53:21 am
Do you know how to get it into the official list (so we can download Solarus docset in Dash/Zeal) ?

It's already on Dash user contributed docsets, so you can download it from the actual Dash app. Just search for it on the downloads section.
Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: Neovyse on April 13, 2018, 12:49:06 pm
I was looking for the Zeal version. Zeal currently does not have official user contributed docsets, but here is a non-official : https://zealusercontributions.herokuapp.com/

Solarus is there  :)
Title: Re: Solarus Quest - Docset (OSX, Windows, Linux)
Post by: santiago_itzcoatl on April 16, 2018, 08:42:16 am
Yes, that is because Zeal gets its docsets from Dash. Zeal User Contributions also comes from Dash's user-contributed docsets.
I just had to upload it to the Dash's user-contributed docsets on Github.

Please let me know if something is wrong with Zeal as I haven't tested it there yet. But I assume it will have no problems.

I'm very happy about at least there is one person who found it useful.  :)