Module:Sandbox/sameboat: Difference between revisions

Module documentation[create] [purge]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

my_object = {};     --All lua modules on wiki must define a global variable 
                    --that will hold their externally accessible functions.
                    --Such global variables can have whatever name you want
                    --and may also return various data as well as functions.

my_object.hello = function( frame )     --Add a function to "my_object".  
                                        --Such functions are callable via #invoke.
                                        --"frame" contains data that Wikipedia
                                        --will send this function when it runs. 
                                        
    return "Hello World!"    --Do nothing but return "Hello World!"
    
end  -- end of function "hello"

return my_object   --All modules end by returning the global variable to Wikipedia.

-- Now we can use this module by calling {{#invoke: Sandbox/sameboat | hello }}.
-- Note that the first part of the invoke is the name of the Module's wikipage,
-- and the second part is the name of one of the functions attached to the 
-- global variable that you returned.

-- The "print" function is not allowed in Wikipedia.  All output is accomplished
-- via strings "returned" to Wikipedia.