Difference between revisions of "Template:MODULE"

From MSX Game Library
 
(33 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<div style="float:right; border: 2px solid #844;">
 
<div style="float:right; border: 2px solid #844;">
−
<div style="background:#F88; padding:0.5em">{{SUBPAGENAME}}</div>
+
<div style="background:#F88; padding:0.5em; font-weight:bold; font-family:monospace; text-align:center; font-size:120%;">{{{name}}}</div>
−
<div style="background:#FEE; padding:0.5em">
+
<div style="background:#FEE; padding:0.5em"><img src="https://{{#if:{{{image|}}}|{{{image}}}|raw.githubusercontent.com/aoineko-fr/MSXgl/main/engine/doc/img/noimage.png}}" style="width:256px;"/>
−
Category: {{{category}}}
+
Code: [https://github.com/aoineko-fr/MSXgl/blob/main/engine/src/{{{name}}}.h {{{name}}}.h]
 +
 
 +
Category: [[:category:Module/{{{category}}}|{{{category}}}]]
  
 
Dependencies:
 
Dependencies:
 
{{#if:{{{dependency1|}}}|* [[Modules/{{{dependency1}}}|{{{dependency1}}}]]|''None''}}{{#if:{{{dependency2|}}}|
 
{{#if:{{{dependency1|}}}|* [[Modules/{{{dependency1}}}|{{{dependency1}}}]]|''None''}}{{#if:{{{dependency2|}}}|
 
* [[Modules/{{{dependency2}}}|{{{dependency2}}}]]}}{{#if:{{{dependency3|}}}|
 
* [[Modules/{{{dependency2}}}|{{{dependency2}}}]]}}{{#if:{{{dependency3|}}}|
−
* [[Modules/{{{dependency3}}}|{{{dependency3}}}]]}}
+
* [[Modules/{{{dependency3}}}|{{{dependency3}}}]]}}{{#if:{{{dependency4|}}}|
 +
* [[Modules/{{{dependency4}}}|{{{dependency4}}}]]}}{{#if:{{{dependency5|}}}|
 +
* [[Modules/{{{dependency5}}}|{{{dependency5}}}]]}}
  
 
Samples:
 
Samples:
 
{{#if:{{{sample1|}}}|* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample1}}}.c {{{sample1}}}]|''None yet''}}{{#if:{{{sample2|}}}|
 
{{#if:{{{sample1|}}}|* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample1}}}.c {{{sample1}}}]|''None yet''}}{{#if:{{{sample2|}}}|
 
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample2}}}.c {{{sample2}}}]}}{{#if:{{{sample3|}}}|
 
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample2}}}.c {{{sample2}}}]}}{{#if:{{{sample3|}}}|
−
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample3}}}.c {{{sample3}}}]}}
+
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample3}}}.c {{{sample3}}}]}}{{#if:{{{sample4|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample4}}}.c {{{sample4}}}]}}{{#if:{{{sample5|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample5}}}.c {{{sample5}}}]}}
 
</div></div>
 
</div></div>
 +
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title=Modules/{{{name}}}/Desc&action=edit ✍]</div>
 +
{{:Modules/{{{name}}}/Desc}}
  
 
==Usage==
 
==Usage==
−
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title={{PAGENAME}}/Usage&action=edit ✍]</div>
+
To use this module, include <tt>"[https://github.com/aoineko-fr/MSXgl/blob/main/engine/src/{{{name}}}.h {{{name}}}.h]"</tt> in your source code, and add <tt>"{{{name}}}"</tt> to the modules list (<tt>LibModules</tt>) in your project's configuration file (<tt>project_config.js</tt>).
−
{{:{{PAGENAME}}/Usage}}
+
 
 +
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title=Modules/{{{name}}}/Usage&action=edit ✍]</div>
 +
{{#ifexist:Modules/{{{name}}}/Usage|{{:Modules/{{{name}}}/Usage}}}}
 +
 
 +
=== Samples ===
 +
See module use cases in the [[Samples|sample programs]]: {{#if:{{{sample1|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample1}}}.c {{{sample1}}}]{{#if:{{{sample1_desc|}}}|&nbsp;({{{sample1_desc}}})}}|''None yet''}}{{#if:{{{sample2|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample2}}}.c {{{sample2}}}]{{#if:{{{sample2_desc|}}}|&nbsp;({{{sample2_desc}}})}}}}{{#if:{{{sample3|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample3}}}.c {{{sample3}}}]{{#if:{{{sample3_desc|}}}|&nbsp;({{{sample3_desc}}})}}}}{{#if:{{{sample4|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample4}}}.c {{{sample4}}}]{{#if:{{{sample4_desc|}}}|&nbsp;({{{sample4_desc}}})}}}}{{#if:{{{sample5|}}}|
 +
* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample5}}}.c {{{sample5}}}]{{#if:{{{sample5_desc|}}}|&nbsp;({{{sample5_desc}}})}}}}
  
 
==Settings==
 
==Settings==
−
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title={{PAGENAME}}/Settings&action=edit ✍]</div>
+
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title=Modules/{{{name}}}/Settings&action=edit ✍]</div>
−
{{:{{PAGENAME}}/Settings}}
+
{{#ifexist:Modules/{{{name}}}/Settings|{{:Modules/{{{name}}}/Settings}}}}
  
 
==Dependencies==
 
==Dependencies==
−
Dependency on other modules:
+
Dependency on other modules: {{#if:{{{dependency1|}}}|
−
{{#if:{{{dependency1|}}}|* [[Modules/{{{dependency1}}}|{{{dependency1}}}]]|''None''}}
+
* [[Modules/{{{dependency1}}}|{{{dependency1}}}]]|''None''}}{{#if:{{{dependency2|}}}|
−
{{#if:{{{dependency2|}}}|* [[Modules/{{{dependency2}}}|{{{dependency2}}}]]}}
+
* [[Modules/{{{dependency2}}}|{{{dependency2}}}]]}}{{#if:{{{dependency3|}}}|
−
{{#if:{{{dependency3|}}}|* [[Modules/{{{dependency3}}}|{{{dependency3}}}]]}}
+
* [[Modules/{{{dependency3}}}|{{{dependency3}}}]]}}{{#if:{{{dependency4|}}}|
−
 
+
* [[Modules/{{{dependency4}}}|{{{dependency4}}}]]}}{{#if:{{{dependency5|}}}|
−
==Appendix==
+
* [[Modules/{{{dependency5}}}|{{{dependency5}}}]]}}
−
<div style="float:right; margin-right:1em;">[https://aoineko.org/msxgl/index.php?title={{PAGENAME}}/Appendix&action=edit ✍]</div>
 
−
{{:{{PAGENAME}}/Appendix}}
 
−
 
 
−
See module use cases in the sample program:
 
−
{{#if:{{{sample1|}}}|* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample1}}}.c {{{sample1}}}]|''None yet''}}
 
−
{{#if:{{{sample2|}}}|* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample2}}}.c {{{sample2}}}]}}
 
−
{{#if:{{{sample3|}}}|* [https://github.com/aoineko-fr/MSXgl/blob/main/projects/samples/{{{sample3}}}.c {{{sample3}}}]}}
 
  
 
==Documentation==
 
==Documentation==
 
{{FRAME_DOC|{{{name}}}}}
 
{{FRAME_DOC|{{{name}}}}}
  
−
<includeonly>[[category:Module]][[category:Module/{{{category}}}]]</includeonly>
+
<includeonly>[[category:Module|{{{name}}}]][[category:Module/{{{category}}}|{{{name}}}]]</includeonly>

Latest revision as of 22:25, 12 January 2024

{{{name}}}

Code: {{{name}}}.h

Category: [[:category:Module/{{{category}}}|{{{category}}}]]

Dependencies: None

Samples: None yet

✍

{{:Modules/{{{name}}}/Desc}}

Usage

To use this module, include "{{{name}}}.h" in your source code, and add "{{{name}}}" to the modules list (LibModules) in your project's configuration file (project_config.js).

✍


Samples

See module use cases in the sample programs: None yet

Settings

✍


Dependencies

Dependency on other modules: None

Documentation


Retrieved from "https://aoineko.org/msxgl/index.php?title=Template:MODULE&oldid=2119"