Exposing ourselves

Ali Lloyd ali.lloyd at livecode.com
Tue Jul 18 16:28:27 CEST 2017


Hi Bob! A markdown guide that goes in here
https://github.com/livecode/livecode-ide/tree/develop/Documentation/guides
would
be wonderful - then it would appear in the guides section of the dictionary
and also be built into the user guide PDF.

Eventually, IDE APIs will be built into an IDE 'dictionary' - these will be
parsed from script comments in the same way that docs are built from widget
comments - eg line 2 in revIDELibrary documents the ideNewControl message:
https://github.com/livecode/livecode-ide/blob/develop/Toolset/libraries/revidelibrary.8.livecodescript#L2

All the necessary code is there to parse these and build the IDE
dictionary, it's just that there's a _lot_ of IDE API to document, so
that's certainly something we could do with help on if anyone has the
inclination. I will make a note to start asking for docs inclusions for IDE
API changes (and indeed requiring them of myself).

On Tue, Jul 18, 2017 at 2:38 PM Bob Hall via use-livecode <
use-livecode at lists.runrev.com> wrote:

> It’s is very possible to create a plugin that customizes the IDE/Script
> Editor to your likely. I have a startup script that modifies many of the
> settings and applies “bug" fixes to the IDE/Script Editor when my Dev
> environment opens. “Bug” fixes are things that either are truly a bug in
> the IDE (real or my opinion) or I just don’t care for the UX that Livecode
> provided out of the box.
>
> I also use a couple of IDE/SE enhancers provided by fellow Livecoders.
> It’s very cool that I am able to modify my dev environment to my liking
> down to the menu items or wha'ts in a window in the App.
>
> Now back to the crux of the problem. There is very limited documentation
> (besides the source code) on how to edit the IDE/Script Editor or how one
> might use the APIs in the IDE/Script Editor. This seems to me to be the
> perfect type of project led by the Community.
>
> Personally I’d envision a simple markdown based repository on Github.
> Maybe if there’s a need to get all fancy it could be either a Gitbook or
> mkdocs based repository. If we wanted to go overboard maybe a stack with a
> doc reader in it so it’s available in the IDE???
>
> I don’t think there needs to be too much structure. Maybe just a defined
> Chapter/sub-chapter structure and place where anyone can edit/post to.
>
> Thoughts?
> Bob Hall
> _______________________________________________
> use-livecode mailing list
> use-livecode at lists.runrev.com
> Please visit this url to subscribe, unsubscribe and manage your
> subscription preferences:
> http://lists.runrev.com/mailman/listinfo/use-livecode


More information about the use-livecode mailing list