Template:File/Doc: Difference between revisions
No edit summary |
m →Usage: added {{expand}}: we should mention (somewhere) that nowiki tag makes some symbols display as `&xyz`. I see this often across the wiki. |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 13: | Line 13: | ||
== Usage == | == Usage == | ||
{{expand|Add note that nowiki breaks stuff like angle brackets}} | |||
Simply include this template in your page, specifying the language, file name and content of the file. Note that you may have to surround the code in <code><<nowiki>nowiki</nowiki>></code> tags in order to display it correctly. | |||
{{code|lang=mediawiki|line=no|<nowiki> | |||
#include <stdio.h> | {{file|main.c|c| | ||
</nowiki><<nowiki>nowiki</nowiki>><nowiki> | |||
#include </nowiki><<nowiki>stdio.h</nowiki>><nowiki> | |||
main( ) | main( ) | ||
| Line 24: | Line 26: | ||
printf("hello, world\n"); | printf("hello, world\n"); | ||
} | } | ||
</nowiki></<nowiki>nowiki</nowiki>><nowiki> | |||
}}</nowiki> | }}</nowiki> | ||
}} | |||
<includeonly> | |||
=== Template data === | |||
<templatedata> | |||
{ | { | ||
"description": "Display a block of code alongside the name of the file it would belong to", | |||
"params": { | |||
"name": { | |||
"label": "File name", | |||
"description": "Name of the file the code belongs to", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"lang": { | |||
"label": "Programming language", | |||
"description": "The programming language used in the code", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"3": { | |||
"label": "Content", | |||
"description": "The code to be displayed", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"1": { | |||
"deprecated": true | |||
}, | |||
"2": { | |||
"deprecated": true | |||
}, | |||
"filename": { | |||
"deprecated": true | |||
}, | |||
"file": { | |||
"deprecated": true | |||
}, | |||
"contents": { | |||
"deprecated": true | |||
}, | |||
"language": { | |||
"deprecated": true | |||
} | |||
} | |||
} | } | ||
</templatedata></includeonly> | |||
Latest revision as of 23:02, 20 May 2026
This template is used to display the content of a file, or otherwise a block of code with the context of which file it would belong to.
🐍︎ main.py
def main():
pass
if __name__ == "__main__":
main()
Usage
☶︎
This article or section needs to be expanded. Further information may be found in the related discussion page. Please consult the pedia article metapage for guidelines on contributing.
Simply include this template in your page, specifying the language, file name and content of the file. Note that you may have to surround the code in <nowiki> tags in order to display it correctly.
{{file|main.c|c|
<nowiki>
#include <stdio.h>
main( )
{
printf("hello, world\n");
}
</nowiki>
}}