Board index FlightGear Development Canvas

Made a Canvas Nasal API page on 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.

Made a Canvas Nasal API page on Wiki

Postby Necolatis » Tue Feb 26, 2013 1:27 am

Hi, hope its okay. I made a wiki with list of canvas elements, methods, parameters and short explanation.

Hope you don't find it redundant. (btw. some methods not filled in/completed, due to unsure how they work)

http://wiki.flightgear.org/Canvas_Nasal_API
"Airplane travel is nature's way of making you look like your passport photo."
— Al Gore


Hangar: https://sites.google.com/site/fghangar/
User avatar
Necolatis
 
Posts: 1986
Joined: Mon Oct 29, 2012 12:40 am
Location: EKOD
Callsign: Leto
IRC name: Neco
Version: 2019.1.2
OS: Windows 10

Re: Made a Canvas Nasal API page on Wiki

Postby Hooray » Tue Feb 26, 2013 5:09 am

Hi,
thanks for doing that, it looks really good.

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:

viewtopic.php?f=71&t=19123&p=177299&hilit=nasal+api+adrian#p177299
viewtopic.php?f=30&t=15133&hilit=python+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: 11340
Joined: Tue Mar 25, 2008 8:40 am

Re: Made a Canvas Nasal API page on Wiki

Postby Necolatis » Tue Feb 26, 2013 7:05 am

No, I did it by hand.

Yeah, I know about the python generation thing, I looked for the docs in the 2.10 distribution, could not find them. So thought writing the wiki myself would probably take same time as getting the python generation running. And I wanted to add some comments that were not in the API anyway, so..
"Airplane travel is nature's way of making you look like your passport photo."
— Al Gore


Hangar: https://sites.google.com/site/fghangar/
User avatar
Necolatis
 
Posts: 1986
Joined: Mon Oct 29, 2012 12:40 am
Location: EKOD
Callsign: Leto
IRC name: Neco
Version: 2019.1.2
OS: Windows 10

Re: Made a Canvas Nasal API page on Wiki

Postby Hooray » Tue Feb 26, 2013 7:42 am

yes, the 2.10 release didn't update the docs using the python script, I already added that to our "lessons learned" section for the next release. Overall, running the script should be fairly simple and only require a python interpreter
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: 11340
Joined: Tue Mar 25, 2008 8:40 am

Re: Made a Canvas Nasal API page on Wiki

Postby jam007 » Tue Feb 26, 2013 8:53 am

Necolatis wrote in Tue Feb 26, 2013 1:27 am:http://wiki.flightgear.org/Canvas_Nasal_API

\o/
More like this will make it much easier for us new to the FG world to understand it and contribute.
jam007
 
Posts: 477
Joined: Sun Dec 16, 2012 10:04 am
Location: Uppsala, Sweden
Version: 2017.3.1
OS: Ubuntu 16.04


Return to Canvas

Who is online

Users browsing this forum: MSN [Bot] and 1 guest