Jump to content

Template:File/Doc: Difference between revisions

From Official NixOS Wiki
DoggoBit (talk | contribs)
No edit summary
DHCP (talk | contribs)
m Usage: added {{expand}}: we should mention (somewhere) that nowiki tag makes some symbols display as `&xyz`. I see this often across the wiki.
 
(One intermediate revision by one other user not shown)
Line 12: Line 12:


== 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.
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.
Line 38: Line 40:
       "description": "Name of the file the code belongs to",
       "description": "Name of the file the code belongs to",
       "type": "string",
       "type": "string",
       "required": true,
       "required": true
      "aliases": ["1"]
     },
     },
     "lang": {
     "lang": {
Line 45: Line 46:
       "description": "The programming language used in the code",
       "description": "The programming language used in the code",
       "type": "string",
       "type": "string",
       "required": true,
       "required": true
      "aliases": ["2"]
     },
     },
     "3": {
     "3": {

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>
}}