User:Red Leader/Nasal documentation proposal: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Update)
 
(15 intermediate revisions by the same user not shown)
Line 14: Line 14:
Form: <code><nowiki>[[Nasal library/<namespace>]]</nowiki></code>
Form: <code><nowiki>[[Nasal library/<namespace>]]</nowiki></code>
{| class="wikitable"
{| class="wikitable"
|+ Nasal namespaces {{progressbar|10}}
|+ Nasal namespaces {{progressbar|30}}
! Namespace !! New page !! Progress
! Namespace !! New page !! Progress
|-
|-
| <code>'''aircraft'''</code>
| <code>'''aircraft'''</code>
| {{N/a|Not started|rowspan{{=}}"4" colspan{{=}}"2"}}
| {{N/a|Not started|rowspan{{=}}"2" colspan{{=}}"2"}}
|-
|-
| <code>'''bits'''</code>
| <code>'''bits'''</code>
|-
|-
| <code>'''clipboard'''</code>
| <code>'''clipboard'''</code> || [[Nasal library/debug]] || {{progressbar|10}}
|-
|-
| <code>'''debug'''</code>
| <code>'''debug'''</code> || [[Nasal library/debug]] || {{done}}
|-
|-
| <code>'''geo'''</code> || [[Nasal library/geo]] || {{done}}
| <code>'''geo'''</code> || [[Nasal library/geo]] || {{done}}
|-
|-
| <code>'''gui'''</code>
| <code>'''gui'''</code>
| {{N/a|Not started|rowspan{{=}}"3" colspan{{=}}"2"}}
| {{N/a|Not started|rowspan{{=}}"2" colspan{{=}}"2"}}
|-
|-
| <code>'''http'''</code>
| <code>'''http'''</code>
|-
|-
| <code>'''io'''</code>
| <code>'''io'''</code> || [[Nasal library/io]] || {{done}}
|-
|-
| <code>'''math'''</code> || [[Nasal library/math]] || {{done}}
| <code>'''math'''</code> || [[Nasal library/math]] || {{done}}
|-
|-
| <code>'''mp_broadcast'''</code>
| <code>'''mp_broadcast'''</code>
| {{N/a|Not started|rowspan{{=}}"3" colspan{{=}}"2"}}
| {{N/a|Not started|colspan{{=}}"2"}}
|-
|-
| <code>'''os[.path]'''</code>
| <code>'''os[.path]'''</code> || [[Nasal library/os.path]] || {{done}}
|-
|-
| <code>'''positioned'''</code>
| <code>'''positioned'''</code>
| {{N/a|Not started|colspan{{=}}"2"}}
|-
|-
| <code>'''props'''</code> || [[Nasal library/props‎‎]] || {{progressbar|60}}
| <code>'''props'''</code> || [[Nasal library/props‎‎]] || {{done}}
|-
|-
| <code>'''scenery'''</code>
| <code>'''scenery'''</code>
Line 64: Line 65:
{| class="wikitable"
{| class="wikitable"
|+ Basic Nasal scripting {{Not done}}
|+ Basic Nasal scripting {{Not done}}
! Subject !! Current page(s)
! 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]]
Line 72: Line 74:
* [[Howto:Understand Namespaces and Methods]]
* [[Howto:Understand Namespaces and Methods]]
* [[Nasal Namespaces in-depth]]
* [[Nasal Namespaces in-depth]]
| [[Hashes in Nasal]]
|-
|-
| Namespaces ||  
| Namespaces
|
* [[Howto:Understand Namespaces and Methods]]
* [[Howto:Understand Namespaces and Methods]]
* [[Nasal Namespaces in-depth]]  
* [[Nasal Namespaces in-depth]]  
* [[Nasal Namespaces]]
* [[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]]
|-  
|-  
| Conditions || [[Nasal Conditionals]]
| Conditionals || [[Nasal Conditionals]] || [[Conditionals in Nasal]]
|-
|-
| Operators || [[Nasal Operators]]
| Operators || [[Nasal Operators]] || [[Operators in Nasal]]
|-
|-
| Loops || [[Nasal Loops]]
| Loops || [[Nasal Loops]] || [[Loops in Nasal]]
|-
|-
| Functions || [[Using Nasal functions]]
| 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 128: Line 138:
| Layout system || [[Canvas Layout System]]
| Layout system || [[Canvas Layout System]]
|-  
|-  
| Widgets || {{N/a|None}}
| Widgets
|
* [[Canvas Widget Matrix]]
* [[Canvas GUI]]
* [[Howto:Creating a Canvas GUI Widget]]
|-
|-
| Canvas MessageBox || [[Canvas MessageBox]]
| Canvas MessageBox || [[Canvas MessageBox]]
Line 151: Line 165:
| heading3 = Getting started
| heading3 = Getting started
| content3 =
| content3 =
* [[Syntax overview]]
* [[Nasal syntax overview|Syntax overview]]
* [[Writing Nasal scripts]]
* [[Writing Nasal scripts]]
* [[Nasal Snippets]]
* [[Nasal Snippets]]
* [[Developing and debugging Nasal code]]


| heading4 = Basic Scripting
| heading4 = Basic Scripting
Line 162: Line 177:
| content5 =
| content5 =
* [[Object orientated programming in Nasal|Object orientated programming]]
* [[Object orientated programming in Nasal|Object orientated programming]]
* [[Nasal String Manipulation]]
* [[Howto:Write a parser in Nasal]]
* [[Nasal Flightplan]]
* [[Nasal Flightplan]]
* [[Callbacks in Nasal]]
* [[Callbacks in Nasal]]
* [[Exception handling with Nasal]]
* [[Exception handling with Nasal]]
* [[Using listeners and signals with Nasal]]
* [[Using listeners and signals with Nasal]]
* [[Developing and debugging Nasal code]]
* [[Caching Nasal function calls]]
* [[Caching Nasal function calls]]
* [[Nasal Unit Testing Framework]] (WIP)
* [[Nasal Unit Testing Framework]] (WIP)
Line 174: Line 186:
* [[A GPX flight logger in Nasal]]
* [[A GPX flight logger in Nasal]]
* [[Multiplayer scripting in Nasal]]
* [[Multiplayer scripting in Nasal]]
| heading6 = Howtos
| content6 =
* [[Howto:Write a parser in Nasal]]
* [[Howto:Making HTTP Requests from Nasal]]
* [[Howto:Making HTTP Requests from Nasal]]
* [[Howto:Transmit properties over MP]]
* [[Howto:Transmit properties over MP]]
Line 189: Line 204:
* [[Howto:Nasal Metaprogramming]]
* [[Howto:Nasal Metaprogramming]]
* [[Nasal/JavaScript Subset]]
* [[Nasal/JavaScript Subset]]
| heading6 = Reference
| heading7 = Reference
| content6 =
| content7 =
* [[Nasal library]] ([[Nasal library#Core library functions|core]]/[[Nasal library#Extension functions|extension]] functions)
* [[Nasal library]] ([[Nasal library#Core library functions|core]]/[[Nasal library#Extension functions|extension]] functions)
** [[Nasal library/geo|<code>geo</code> namespace]]
** [[Nasal library/geo|<code>geo</code> namespace]]
** [[Nasal library/io|<code>io</code> namespace]]
** [[Nasal library/math|<code>math</code> namespace]]
** [[Nasal library/math|<code>math</code> namespace]]
** [[Nasal library/props|<code>props</code> namespace]]
** [[Nasal library/props|<code>props</code> namespace]]
* [[Nasal String Manipulation]]
}}
}}
{{Nasal Internals}}
{{Nasal Internals}}
{{-}}
{{-}}
== Misc ==
== Misc ==
* Merge [[Nasal scripting language]] and [[What is Nasal]] into [[Nasal]]
* 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

Nasal library Done Done
Old page(s) New page
Nasal library

Form: [[Nasal library/<namespace>]]

Nasal namespaces 30}% completed
Namespace New page Progress
aircraft Not started
bits
clipboard Nasal library/debug 10}% completed
debug Nasal library/debug Done Done
geo Nasal library/geo Done Done
gui Not started
http
io Nasal library/io Done Done
math Nasal library/math Done Done
mp_broadcast Not started
os[.path] Nasal library/os.path Done Done
positioned Not started
props Nasal library/props‎‎ Done Done
scenery Not started
screen
std (current page: Vector)
string
thread
utf8
view
Basic Nasal scripting Not done Not done
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
Advanced Nasal scripting Not done Not done
What? Current page(s) New page
Vector slicing Nasal Variables Vectors in Nasal
OOP Object orientated programming in Nasal
Canvas API Not done Not done
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

Navbox

FlightGear logo.png The FlightGear forum has a
subforum related to: Nasal
Nasallogo3.png
Nasal scripting
Success stories • FAQ
Tools and utilities
Console • REPL Console • Browser • Syntax highlighting
Getting started
Basic Scripting
Hashes • Variables • Operators • Functions • Namespaces • Strings • Vectors • Conditionals • Numbers • Loops
Advanced Scripting
Howtos
Reference
(click on headings to toggle)
Nasallogo3.png
Nasal internals
Memory Management (GC)


Misc

Retrieved from "https://wiki.flightgear.org/w/index.php?title=User:Red_Leader/Nasal_documentation_proposal&oldid=115036"