User:Red Leader/Nasal documentation proposal: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) (Some updates) |
Red Leader (talk | contribs) (Update) |
||
(35 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
Proposal for the documentation of the [[Nasal]] API. | Proposal for the documentation of the [[Nasal]] API. | ||
__TOC__ | |||
== Documentation pages == | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ Nasal library {{ | |+ Nasal library {{Done}} | ||
! Old page(s) | ! Old page(s) !! New page | ||
|- | |- | ||
| | | | ||
* [[Nasal library functions]] ([http://wiki.flightgear.org/index.php?title=Nasal_library_functions&oldid=93458 perm]) | * [[Nasal library functions]] ([http://wiki.flightgear.org/index.php?title=Nasal_library_functions&oldid=93458 perm]) | ||
* [[List of Nasal extension functions]] ([http://wiki.flightgear.org/index.php?title=List_of_Nasal_extension_functions&oldid=72953 perm]) | * [[List of Nasal extension functions]] ([http://wiki.flightgear.org/index.php?title=List_of_Nasal_extension_functions&oldid=72953 perm]) | ||
|| [[Nasal library]] | || [[Nasal library]] | ||
|} | |} | ||
Form: <code><nowiki>[[Nasal library/<namespace>]]</nowiki></code> | |||
{| class="wikitable" | {| class="wikitable" | ||
|+ Nasal namespaces {{ | |+ Nasal namespaces {{progressbar|30}} | ||
! Namespace !! | ! Namespace !! New page !! Progress | ||
|- | |- | ||
| <code>'''aircraft'''</code> | | <code>'''aircraft'''</code> | ||
| {{N/a|Not started|rowspan{{=}}" | | {{N/a|Not started|rowspan{{=}}"2" colspan{{=}}"2"}} | ||
|- | |- | ||
| <code>'''bits'''</code> | | <code>'''bits'''</code> | ||
|- | |- | ||
| <code>''' | | <code>'''clipboard'''</code> || [[Nasal library/debug]] || {{progressbar|10}} | ||
|- | |- | ||
| <code>''' | | <code>'''debug'''</code> || [[Nasal library/debug]] || {{done}} | ||
|- | |- | ||
| <code>''' | | <code>'''geo'''</code> || [[Nasal library/geo]] || {{done}} | ||
|- | |- | ||
| <code>'''gui'''</code> | | <code>'''gui'''</code> | ||
| {{N/a|Not started|rowspan{{=}}"2" colspan{{=}}"2"}} | |||
|- | |- | ||
| <code>''' | | <code>'''http'''</code> | ||
|- | |- | ||
| <code>''' | | <code>'''io'''</code> || [[Nasal library/io]] || {{done}} | ||
|- | |- | ||
| <code>'''math'''</code> || [[ | | <code>'''math'''</code> || [[Nasal library/math]] || {{done}} | ||
|- | |- | ||
| <code>'''mp_broadcast'''</code> | | <code>'''mp_broadcast'''</code> | ||
| {{N/a|Not started| | | {{N/a|Not started|colspan{{=}}"2"}} | ||
|- | |- | ||
| <code>'''props'''</code> | | <code>'''os[.path]'''</code> || [[Nasal library/os.path]] || {{done}} | ||
|- | |||
| <code>'''positioned'''</code> | |||
| {{N/a|Not started|colspan{{=}}"2"}} | |||
|- | |||
| <code>'''props'''</code> || [[Nasal library/props]] || {{done}} | |||
|- | |- | ||
| <code>'''scenery'''</code> | | <code>'''scenery'''</code> | ||
| {{N/a|Not started|rowspan{{=}}"7" colspan{{=}}"2"}} | |||
|- | |- | ||
| <code>'''screen'''</code> | | <code>'''screen'''</code> | ||
|- | |- | ||
| <code>'''std'''</code> | | <code>'''std'''</code> (current page: [[Vector]]) | ||
|- | |- | ||
| <code>'''string'''</code> | | <code>'''string'''</code> | ||
|- | |||
| <code>'''thread'''</code> | |||
|- | |||
| <code>'''utf8'''</code> | |||
|- | |- | ||
| <code>'''view'''</code> | | <code>'''view'''</code> | ||
Line 54: | Line 65: | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ Basic Nasal scripting {{Not done}} | |+ Basic Nasal scripting {{Not done}} | ||
! | ! Subject !! Current page(s) !! New page | ||
|- | |- | ||
| Hashes | | Hashes | ||
| | |||
* [[Howto:Start using vectors and hashes in Nasal]] | * [[Howto:Start using vectors and hashes in Nasal]] | ||
* [[Object Oriented Programming with Nasal]] | * [[Object Oriented Programming with Nasal]] | ||
* [[Object oriented programming in Nasal]] | * [[Object oriented programming in Nasal]] | ||
* [[Howto:Understand Namespaces and Methods]] | |||
* [[Nasal Namespaces in-depth]] | |||
| [[Hashes in Nasal]] | |||
|- | |||
| Namespaces | |||
| | |||
* [[Howto:Understand Namespaces and Methods]] | * [[Howto:Understand Namespaces and Methods]] | ||
* [[Nasal Namespaces in-depth]] | * [[Nasal Namespaces in-depth]] | ||
* [[Nasal Namespaces]] | |||
| [[Namespaces in Nasal]] | |||
|- | |- | ||
| Numbers | | Numbers || {{N/a|Very little}} || [[Numbers in Nasal]] | ||
| {{N/a|Very little}} | |||
|- | |- | ||
| Vectors | | Vectors | ||
| | |||
* [[Nasal Variables]] | * [[Nasal Variables]] | ||
* [[Howto:Use vectors and foreach loops to write shorter code]] | * [[Howto:Use vectors and foreach loops to write shorter code]] | ||
* [[Howto:Start using vectors and hashes in Nasal]] | * [[Howto:Start using vectors and hashes in Nasal]] | ||
| [[Vectors in Nasal]] | |||
|- | |- | ||
| Strings || [[Nasal Hello World]] | | Strings || [[Nasal Hello World]] || [[Strings in Nasal]] | ||
|- | |- | ||
| | | Conditionals || [[Nasal Conditionals]] || [[Conditionals in Nasal]] | ||
|- | |||
| Operators || [[Nasal Operators]] || [[Operators in Nasal]] | |||
|- | |- | ||
| | | Loops || [[Nasal Loops]] || [[Loops in Nasal]] | ||
|- | |- | ||
| | | Functions || [[Using Nasal functions]] || [[Functions in Nasal]] | ||
|- | |- | ||
| | | Variables || [[Nasal Variables]] || [[Variables in Nasal]] | ||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
|+ Advanced Nasal scripting {{Not done}} | |+ Advanced Nasal scripting {{Not done}} | ||
! What? !! Current page(s) | ! What? !! Current page(s) !! New page | ||
|- | |- | ||
| Vector slicing || [[Nasal Variables]] | | Vector slicing || [[Nasal Variables]] || [[Vectors in Nasal]] | ||
|- | |- | ||
| OOP | | OOP | ||
| | |||
* [[Object Oriented Programming with Nasal]] | * [[Object Oriented Programming with Nasal]] | ||
* [[Object oriented programming in Nasal]] | * [[Object oriented programming in Nasal]] | ||
| [[Object orientated programming in Nasal]] | |||
|} | |} | ||
Line 113: | Line 138: | ||
| Layout system || [[Canvas Layout System]] | | Layout system || [[Canvas Layout System]] | ||
|- | |- | ||
| Widgets | | | Widgets | ||
| | |||
* [[Canvas Widget Matrix]] | |||
* [[Canvas GUI]] | |||
* [[Howto:Creating a Canvas GUI Widget]] | |||
|- | |- | ||
| Canvas MessageBox || [[Canvas MessageBox]] | | Canvas MessageBox || [[Canvas MessageBox]] | ||
|} | |} | ||
== Navbox == | |||
{{forum|30|Nasal}} | |||
{{sidebar with collapsible headers | |||
| topimage = [[File:Nasallogo3.png]] | |||
| name = Nasal Navigation | |||
| title = [[Nasal|Nasal scripting]] | |||
| contentstyle = text-align: left; | |||
| state = collapsed | |||
| content1style = text-align: center; | |||
| content1 = [[Nasal success stories|Success stories]] • [[Nasal FAQ|FAQ]] | |||
| heading2 = Tools and utilities | |||
| content2style = text-align: center; | |||
| content2 = [[Nasal Console|Console]] • [[Interactive Nasal Console|REPL Console]] • [[Nasal Browser|Browser]] • [[Howto:Syntax highlighting for Nasal|Syntax highlighting]] | |||
| heading3 = Getting started | |||
| content3 = | |||
* [[Nasal syntax overview|Syntax overview]] | |||
* [[Writing Nasal scripts]] | |||
* [[Nasal Snippets]] | |||
* [[Developing and debugging Nasal code]] | |||
| heading4 = Basic Scripting | |||
| content4style = text-align: center; | |||
| content4 = [[Hashes in Nasal|Hashes]] • [[Variables in Nasal|Variables]] • [[Operators in Nasal|Operators]] • [[Functions in Nasal|Functions]] • [[Namespaces in Nasal|Namespaces]] • [[Strings in Nasal|Strings]] • [[Vectors in Nasal|Vectors]] • [[Conditionals in Nasal|Conditionals]] • [[Numbers in Nasal|Numbers]] • [[Loops in Nasal|Loops]] | |||
| heading5 = Advanced Scripting | |||
| content5 = | |||
* [[Object orientated programming in Nasal|Object orientated programming]] | |||
* [[Nasal Flightplan]] | |||
* [[Callbacks in Nasal]] | |||
* [[Exception handling with Nasal]] | |||
* [[Using listeners and signals with Nasal]] | |||
* [[Caching Nasal function calls]] | |||
* [[Nasal Unit Testing Framework]] (WIP) | |||
* [[Nasal Meta-Programming]] | |||
* [[A GPX flight logger in Nasal]] | |||
* [[Multiplayer scripting in Nasal]] | |||
| heading6 = Howtos | |||
| content6 = | |||
* [[Howto:Write a parser in Nasal]] | |||
* [[Howto:Making HTTP Requests from Nasal]] | |||
* [[Howto:Transmit properties over MP]] | |||
* [[Howto:Terrain sampling in Nasal]] | |||
* [[Howto:Create a new system in Nasal]] | |||
* [[Howto:Load a Nasal file at runtime]] | |||
* [[Howto:Control the route manager in Nasal]] | |||
* [[Howto:Get a number of elevation offsets for a number of objects]] | |||
* [[Howto:Nasal in scenery object XML files]] | |||
* [[Howto:Create animation XML files from Nasal]] | |||
* [[Howto:Port I/O from Nasal]] | |||
* [[Howto:Continuation-passing style programming in Nasal]] | |||
* [[Howto:Start worker threads using listeners in Nasal]] | |||
* [[Howto:Developing a DSL interpreter in Nasal]] | |||
* [[Howto:Nasal Metaprogramming]] | |||
* [[Nasal/JavaScript Subset]] | |||
| heading7 = Reference | |||
| content7 = | |||
* [[Nasal library]] ([[Nasal library#Core library functions|core]]/[[Nasal library#Extension functions|extension]] functions) | |||
** [[Nasal library/geo|<code>geo</code> namespace]] | |||
** [[Nasal library/io|<code>io</code> namespace]] | |||
** [[Nasal library/math|<code>math</code> namespace]] | |||
** [[Nasal library/props|<code>props</code> namespace]] | |||
* [[Nasal String Manipulation]] | |||
}} | |||
{{Nasal Internals}} | |||
{{-}} | |||
== Misc == | |||
* Merge [[Nasal scripting language]] and [[What is Nasal]] into [[Nasal]] | |||
[[Category:Nasal namespace documentation]] |
Latest revision as of 09:42, 26 April 2018
Proposal for the documentation of the Nasal API.
Documentation pages
Old page(s) | New page |
---|---|
Nasal library |
Form: [[Nasal library/<namespace>]]
Namespace | New page | Progress |
---|---|---|
aircraft
|
Not started | |
bits
| ||
clipboard |
Nasal library/debug | |
debug |
Nasal library/debug | Done |
geo |
Nasal library/geo | Done |
gui
|
Not started | |
http
| ||
io |
Nasal library/io | Done |
math |
Nasal library/math | Done |
mp_broadcast
|
Not started | |
os[.path] |
Nasal library/os.path | Done |
positioned
|
Not started | |
props |
Nasal library/props | Done |
scenery
|
Not started | |
screen
| ||
std (current page: Vector)
| ||
string
| ||
thread
| ||
utf8
| ||
view
|
Subject | Current page(s) | New page |
---|---|---|
Hashes | Hashes in Nasal | |
Namespaces | Namespaces in Nasal | |
Numbers | Very little | Numbers in Nasal |
Vectors | Vectors in Nasal | |
Strings | Nasal Hello World | Strings in Nasal |
Conditionals | Nasal Conditionals | Conditionals in Nasal |
Operators | Nasal Operators | Operators in Nasal |
Loops | Nasal Loops | Loops in Nasal |
Functions | Using Nasal functions | Functions in Nasal |
Variables | Nasal Variables | Variables in Nasal |
What? | Current page(s) | New page |
---|---|---|
Vector slicing | Nasal Variables | Vectors in Nasal |
OOP | Object orientated programming in Nasal |
What? | Current page(s) |
---|---|
Canvas Element | Canvas Element |
Canvas Image | Canvas Image |
Canvas Path | Canvas Path |
Canvas Map |
|
Event handling | Canvas Event Handling |
Canvas GUI | |
Layout system | Canvas Layout System |
Widgets | |
Canvas MessageBox | Canvas MessageBox |
The FlightGear forum has a subforum related to: Nasal |
Nasal internals |
---|
Memory Management (GC) |
Misc
- Merge Nasal scripting language and What is Nasal into Nasal