Template:Macro: Difference between revisions
No edit summary |
(→Note) |
||
| Line 32: | Line 32: | ||
<noinclude> | <noinclude> | ||
= | =Notes= | ||
{{Hint|'''OSE needs documentation on how to generate templates, with focus on templates such as infoboxes like here, and templates for machine development such as Template:GVCS Header. This would allow more people to organize the wiki effectively. Passing of page names into the template is very useful. Templates can be nested, which is powerful.}} | {{Hint|'''OSE needs documentation on how to generate templates, with focus on templates such as infoboxes like here, and templates for machine development such as Template:GVCS Header. This would allow more people to organize the wiki effectively. Passing of page names into the template is very useful. Templates can be nested, which is powerful.}} | ||
Template borrowed from FreeCAD wiki. At the FreeCAD wiki, this template is used to document different FreeCAD Macros. | Template borrowed from FreeCAD wiki. This shows that any mediawiki instance can be used to borrow useful templates. At the FreeCAD wiki, this template is used to document different FreeCAD Macros. | ||
See source at https://www.freecadweb.org/wiki/Template:Macro | See source at https://www.freecadweb.org/wiki/Template:Macro | ||
=Usage= | |||
This Template is the main anchor on documenting macros. | This Template is the main anchor on documenting macros. | ||
<nowiki>{{Macro|Icon=Text-x-python|Name=myMacro|Description=What my macro does|Author=YourWikiUserName|Version=2.0|Date=YYYY-MM-DD}}</nowiki> | <nowiki>{{Macro|Icon=Text-x-python|Name=myMacro|Description=What my macro does|Author=YourWikiUserName|Version=2.0|Date=YYYY-MM-DD}}</nowiki> | ||
Latest revision as of 23:36, 1 March 2018
File:Text-x-python.png {{{Name}}} |
| Description |
|---|
| None |
| Author |
| [[User:{{{Author}}}|{{{Author}}}]] |
| Links |
| Macros recipes How to install macros How to customize toolbars |
| Version |
| 1.0 |
| Date last modification |
| YYYY-MM-DD |
Notes
Hint: OSE needs documentation on how to generate templates, with focus on templates such as infoboxes like here, and templates for machine development such as Template:GVCS Header. This would allow more people to organize the wiki effectively. Passing of page names into the template is very useful. Templates can be nested, which is powerful.
Template borrowed from FreeCAD wiki. This shows that any mediawiki instance can be used to borrow useful templates. At the FreeCAD wiki, this template is used to document different FreeCAD Macros.
See source at https://www.freecadweb.org/wiki/Template:Macro
Usage
This Template is the main anchor on documenting macros.
{{Macro|Icon=Text-x-python|Name=myMacro|Description=What my macro does|Author=YourWikiUserName|Version=2.0|Date=YYYY-MM-DD}}
You can also upload icon custom format .png with the same name as the macro,
example: "myMacro" without extension (the extension is given by the system), and replace " Icon =Text-x-python by Icon=myMacro "
Text-x-python File:Text-x-python.png is the default icon of the page dedicated to the Macro