lcdoc & contributing to dictionary

Working group for improving LiveCode's User Guide, Dictionary, and other learning resorces.

Moderators: Klaus, FourthWorld, heatherlaine, kevinmiller, robinmiller

Post Reply
scrabbles
Posts: 25
Joined: Sat Dec 20, 2014 4:32 am
Location: Melbourne, Australia

lcdoc & contributing to dictionary

Post by scrabbles » Fri Aug 21, 2015 3:11 am

Hi,

I've written a little script to create a Dash app "docset" as I noticed there wasn't already one ..anyway ... I didn't know what Livecode documentation to base it on—I can see 3 different types of livecode documentation: XML, lcdoc, and in LC8 I see json (locally installed, not on github).

I used the lcdoc—is that the most sensible choice going forward? Is there a spec for it? I recall seeing a blog post on livecode about the doco format changing, and lcdoc was proposed (suggesting XML deprecated) but I don't think it was finalised?

So ... if i wanted to help fix some documentation problems (formatting, typos, add examples, etc) what files am i forking and making pull requests on in github? the lcdocs?

thanks for any help

- mark

scrabbles
Posts: 25
Joined: Sat Dec 20, 2014 4:32 am
Location: Melbourne, Australia

Re: lcdoc & contributing to dictionary

Post by scrabbles » Tue Aug 25, 2015 12:22 pm

Just to answer my own questions in case it benefits others:
  • - lcdoc does seem to be the format going forward in v8 (I am unsure if changes get back ported to 6x though, i think they do for 7.1)
    - The LCv8 dictionary (open it in livecode) has a guide tab, which has a specifications section explaining the lcdoc format.
    - Pull requests (on github) can be made for (signed up) contributors. The lcdocs are fine to edit and submit PRs for.

MaxV
Posts: 1357
Joined: Tue May 28, 2013 2:20 pm
Location: Italy
Contact:

Re: lcdoc & contributing to dictionary

Post by MaxV » Wed Jan 20, 2016 10:30 am

Where is the documentation for lcdoc format?
Livecode Wiki: http://livecode.wikia.com
My blog: http://livecodeitalia.blogspot.it
To post code use this: http://tinyurl.com/ogp6d5w

bn
VIP Livecode Opensource Backer
VIP Livecode Opensource Backer
Posts: 3193
Joined: Sun Jan 07, 2007 9:12 pm
Location: Bochum, Germany

Re: lcdoc & contributing to dictionary

Post by bn » Wed Jan 20, 2016 10:40 am


MaxV
Posts: 1357
Joined: Tue May 28, 2013 2:20 pm
Location: Italy
Contact:

Re: lcdoc & contributing to dictionary

Post by MaxV » Wed Jan 20, 2016 11:09 am

Livecode Wiki: http://livecode.wikia.com
My blog: http://livecodeitalia.blogspot.it
To post code use this: http://tinyurl.com/ogp6d5w

Post Reply

Return to “Learning Resources”