Board index FlightGear Development Canvas

Canvas GUI API documentation in wiki

Canvas is FlightGear's new fully scriptable 2D drawing system that will allow you to easily create new instruments, HUDs and even GUI dialogs and custom GUI widgets, without having to write C++ code and without having to rebuild FlightGear.

Canvas GUI API documentation in wiki

Postby jsb » Sat Jan 14, 2017 4:41 pm

As I was lacking some documentation, I wrote it

http://wiki.flightgear.org/Canvas_GUI_API

HTH :)
jsb
 
Posts: 207
Joined: Sat Oct 25, 2014 8:17 pm
Location: Hamburg, Germany
Callsign: D-JSB
Version: next
OS: Win7/Linux

Re: Canvas GUI API documentation in wiki

Postby yanes » Sat Jan 14, 2017 8:22 pm

Really great idea , the lack of documentation , the nightmare of any canvas dialog coder ,
I was forced to dig into internal canvas modules to find the correct bindings/calls,
Even it's incomplete but it's nice step .
Thank you buddy ,
User avatar
yanes
 
Posts: 113
Joined: Tue Sep 02, 2014 1:14 pm
Location: Tunisia
Callsign: YANES
Version: 2018.2.2
OS: Linux

Re: Canvas GUI API documentation in wiki

Postby Hooray » Wed Jan 25, 2017 1:52 pm

thank you for following up on the original suggestion - however, please be aware that there's a dedicated Python script that can help automatically extract most of the boilerplate structure you ended up using to create the wiki stub - see Adrian's work
Please don't send support requests by PM, instead post your questions on the forum so that all users can contribute and benefit
Thanks & all the best,
Hooray
Help write next month's newsletter !
pui2canvas | MapStructure | Canvas Development | Programming resources
Hooray
 
Posts: 11162
Joined: Tue Mar 25, 2008 8:40 am

Re: Canvas GUI API documentation in wiki

Postby jsb » Thu Jan 26, 2017 10:18 pm

*?*
Details? Where is it? What does it? :)
jsb
 
Posts: 207
Joined: Sat Oct 25, 2014 8:17 pm
Location: Hamburg, Germany
Callsign: D-JSB
Version: next
OS: Win7/Linux

Re: Canvas GUI API documentation in wiki

Postby Alant » Thu Jan 26, 2017 10:38 pm

jsb

Many thanks.

Alan
Alant
 
Posts: 745
Joined: Wed Jun 23, 2010 5:58 am
Location: Portugal
Callsign: Tarnish99
Version: from Git
OS: Windows 10

Re: Canvas GUI API documentation in wiki

Postby Hooray » Fri Feb 24, 2017 3:19 pm

jsb wrote in Thu Jan 26, 2017 10:18 pm:Details? Where is it? What does it? :)


See the topic I mentioned:

Canvas API documentation
Hooray wrote:Adrian's nasal_api_doc.py script in $FG_SRC/scripts/python should automatically create updated API documentation based on the nasal source code in $FG_ROOT/Nasal (html output).


Hooray wrote in Tue Feb 26, 2013 5:09 am:However, it must have been a lot of work, unless you used a script to create all the wiki markup semi-automatically ?
Just keep in mind that we have a python script that can help with the generation of Nasal API docs:

http://flightgear.org/forums/viewtopic. ... an#p177299
http://flightgear.org/forums/viewtopic. ... +nasal+api

The idea is to be usable, even for "non-stable" APIs, such as the Canvas stuff which is work in progress.

To be really useful, this should normally be run shortly prior to distributing the release obviously...
Please don't send support requests by PM, instead post your questions on the forum so that all users can contribute and benefit
Thanks & all the best,
Hooray
Help write next month's newsletter !
pui2canvas | MapStructure | Canvas Development | Programming resources
Hooray
 
Posts: 11162
Joined: Tue Mar 25, 2008 8:40 am


Return to Canvas

Who is online

Users browsing this forum: No registered users and 1 guest