Dash docset creator for LiveCode

Are you developing tools to extend the LiveCode environment? This is the place to talk about the nuts and bolts of extending our nuts and bolts. If you want to use a LiveCode or third party Environment extension, visit the Using Evironment Extensions forum.

Moderators: heatherlaine, Klaus, FourthWorld, robinmiller, kevinmiller

capellan
Posts: 492
Joined: Wed Aug 15, 2007 11:09 pm
Contact:

Re: Dash docset creator for LiveCode

Post by capellan » Tue Nov 28, 2017 2:32 am

Thanks a lot for your advice! :D
I'll look for the best way to create this html index.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Tue Nov 28, 2017 2:48 am

I am intrigued. Does not lovelydocs allow you to download docsets from the “user contribution” site?
The reason I ask is that they have they the latest available docset (lc9dp10).

capellan
Posts: 492
Joined: Wed Aug 15, 2007 11:09 pm
Contact:

Re: Dash docset creator for LiveCode

Post by capellan » Tue Nov 28, 2017 8:09 am

No, Lovely Docs shows only the main repository

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Tue Nov 28, 2017 8:36 am

Is that because it is the free version.i noticed they have a pro version but apart from allowing more docsets I do not know what it offers. I haven’t found the develop’s website to clarify. If it can’t access the user contribution site it is a real bummer as there are a lot of them...
https://github.com/Kapeli/Dash-User-Con ... er/docsets

James

capellan
Posts: 492
Joined: Wed Aug 15, 2007 11:09 pm
Contact:

Re: Dash docset creator for LiveCode

Post by capellan » Tue Nov 28, 2017 9:21 pm

Where could I download the archive: LiveCode.tgz?

I could try to drop this file into the docset folder
of the android app "Lovely Docs" to learn if the
app recognizes the .tgz archive as a new docset.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Wed Nov 29, 2017 12:35 am

I wish I knew. Reading on the Dash website, the developers for other platforms are required to work with the Dash developer to ensure compatibility. Given one of the major selling points was the ability to access the user contributions I am perplexed as to why ‘lovelydocs’ can’t. You might need to write to the lovelydocs developer to find out how or if it can be done.

capellan
Posts: 492
Joined: Wed Aug 15, 2007 11:09 pm
Contact:

Re: Dash docset creator for LiveCode

Post by capellan » Wed Nov 29, 2017 5:19 am

Given that author website is unavailable, creating an html index would be faster. :)

mwieder
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 2695
Joined: Mon Jan 22, 2007 7:36 am
Location: Berkeley, CA, US
Contact:

Installing the docset on linux

Post by mwieder » Sun Dec 24, 2017 3:06 am

The LiveCode docset isn't listed on the Dash website.
And Zeal on linux doesn't list it either.
Zeal offered me the option to load a docset from a url, but on github I see that Dash has already incorporated the LiveCode docset into the CDN and removed it from the github repo.

Took me a bit of sleuthing to get the LC9 docset installed onto Zeal on linux. For anyone following, I:
  • ran Make-docset from the LiveCode 9-dp11 IDE
  • used the default settings, so the LiveCode.docset folder was created in my home folder
  • copied the docset folder into ~/.local/share/Zeal/Zeal/docsets
  • closed and restarted Zeal
Now LiveCode shows up in the installed docsets.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Sun Dec 24, 2017 3:40 am

Sorry about that. Only working with Dash it self I don’t know what limitations exist on the non Mac platforms.
I see there was an interesting and long discussion of this issue on the Zeal repository.
Perhaps you might follow it better than I.
https://github.com/zealdocs/zeal/issues/170

mwieder
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 2695
Joined: Mon Jan 22, 2007 7:36 am
Location: Berkeley, CA, US
Contact:

Re: Dash docset creator for LiveCode

Post by mwieder » Sun Dec 24, 2017 6:15 pm

Whew! There's a lot of history there.
I see https://zealusercontributions.herokuapp.com/ does have an xml file for LiveCode. That seems to do the trick, although for some reason the xml data lists the version as 1.2. I loaded the url into Zeal and it did indeed load the proper 1.3 version, so I think the heroku site should be considered the most up-to-date repository of docsets.

...and my thanks to sntiagoma for setting up the CDN docset app in the first place.
I grabbed the Kotlin docset while I was at it, because Kotlin.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Sat Feb 03, 2018 3:30 am

Seems the widget libraries are now (dp11) of type “module” which meant they were overlooked when looking for associated properties, functions etc.
This has now been corrected as of version 2.5

Version 2.5
• Adjust internal cross ref to account for change of widget libray type to "module"

Version 2.4
• Fixed keyword index for database
(Control structures now appear under the key phrase "Control Structures".)

The user contributed docset for LiveCode is now at version 1.4.2 and has these corrections.
Within Dash it now appears that all item types are correctly identified and listed. They even all have icons now :D Can’t speak for other readers.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Thu Mar 15, 2018 2:09 pm

The Livecode Dash Docset has been updated to version 1.5 and has been compiled from the LC 9.0.0 rc1 documentation.

The "Make Docset" stack on LivecodeShare has been updated to version 2.6 (modified version algorithm to catch fully the LC 9 series.)
http://livecodeshare.runrev.com/stack/845/Make-DocSet

Enjoy.

jameshale
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 253
Joined: Thu Sep 04, 2008 6:23 am
Location: Melbourne Australia

Re: Dash docset creator for LiveCode

Post by jameshale » Sun Aug 26, 2018 4:50 pm

With the release of 9.01 the "Guides" section of the dictionary now includes guide for the widgets.
These guides come from documentation within the widget folder (within the Extensions folder of the LC package.)

I have now added the code to the "Make Docset" stack on LiveCodeShare to generate the appropriate guide files for inclusion into the DASH LiveCode docset.

The online DASH repository should be updated with this docset later this week. If you want it sooner just download the "Make Docset" stack and roll your own.

James

Post Reply

Return to “Extending LiveCode”