Löve2D documentation (docset) for offline browsing

[cjanssen]

Hello all,

a few days ago I was looking for a way to quickly check documentation for keywords as I type in a text editor (a.k.a "contextual help", the good old F1). It turns out there's a few tools for that, one of them being "Zeal", but I wasn't able to find a Löve2D package for it (called "docset" in the Zeal world). Googling for love2d offline documentation sent me to the thread in this forum where it's mentioned that we can download the wiki as a single zipfile for offline browsing, which is already something good to have. I thought I could go one step further and create a docset, so if you're using Zeal or an equivalent program, you can make use of it.

https://github.com/ChrisJan00/love2d_docset

Some more explanation:
https://chrisjangames.wordpress.com/201 ... -browsing/

If you don't know about Zeal and you're curious:
http://zealdocs.org/

[Linkpy]

So...

1. You made me discover Zeal. Thanks you.
2. You made a Love2D docset. With my sloooow PC, it's great. Thanks you.

So... In conclusion. Thanks you..

[bakpakin]

Will this work with Dash? I don't really know much about Dash or Zeal, but offline documentation and integration with IDEs and text editors seems pretty great, on I want this on my mac.

[portify]

So...

1. You made me discover Zeal. Thanks you.
2. You made a Love2D docset. Thanks you.

So... In conclusion. Thanks you..

Basically this! Going somewhere soon, this is going to be really convenient.

[cjanssen]

Will this work with Dash? I don't really know much about Dash or Zeal, but offline documentation and integration with IDEs and text editors seems pretty great, on I want this on my mac.

In theory it works with Dash too. You should be able to open the docset and browse it without problems. I don't have a mac to test, though, hopefully nothing is messed up too badly.

[bakpakin]

Will this work with Dash? I don't really know much about Dash or Zeal, but offline documentation and integration with IDEs and text editors seems pretty great, on I want this on my mac.

In theory it works with Dash too. You should be able to open the docset and browse it without problems. I don't have a mac to test, though, hopefully nothing is messed up too badly.

Confirmed, works in Dash!

[Shviller]

Looks like I'm having a problem with colons. The moment I enter one, I lose all results:

Am I doing something wrong?
(using Zeal 0.1.1, built Apr 20 2015, in case it matters)

[qubodup]

Looks like I'm having a problem with colons. The moment I enter one, I lose all results:
(using Zeal 0.1.1, built Apr 20 2015, in case it matters)

I can reproduce this on Linux with zeal-git except when the colon is the first character (then it works).



There seems to be no report of this exactly, so you might want to add it to https://github.com/zealdocs/zeal/issues ... open+colon

I made a basic video on how to set up:

http://youtu.be/B_onR_0oOZQ

Also there's a Mac OS X Zeal binary available from http://www.mediafire.com/download/537is ... elease.dmg (taken from http://www.hjue.me/post/Compile-Zear-on-Mac-OS-X )

[Shviller]

Looks like I'm having a problem with colons.

Am I doing something wrong?

Turns out, I was doing something wrong. Specifically, Zeal uses colons to specify a prefix that narrows the search down to specific docsets. So in my case, I want not just `ImageData:`, but rather `lua 5.1,love2d:ImageData:`:

(Please note that these prefixes have to be lowercase)

I chose this prefix so that I don't have to distinguish between Löve and non-Löve Lua, and I chose 5.1 because it seems LuaJIT is closer to 5.1 than to 5.2.

Sadly, the docsets for Lua that the stock feed provides aren't all that good; when you choose a result from them you get the top of the "Lua 5.X Reference Manual" page, instead of the relevant position on that page. So if somebody finds/makes a better docset, that'd be very handy.

Last but not least: thanks, cjanssen! Now the lack of CHM docs for Löve is no longer a problem for all the people still caring about that format, all two of them.

[qubodup]

Sadly, the docsets for Lua that the stock feed provides aren't all that good; when you choose a result from them you get the top of the "Lua 5.X Reference Manual" page, instead of the relevant position on that page. So if somebody finds/makes a better docset, that'd be very handy.

Not sure what you mean, looks fine to me: http://youtu.be/30jWqWo3G9w