Jump to content

Template:File/Doc: Difference between revisions

From NixOS Wiki
DoggoBit (talk | contribs)
No edit summary
DoggoBit (talk | contribs)
m Template data: remove aliases
 
(2 intermediate revisions by the same user not shown)
Line 13: Line 13:
== Usage ==
== Usage ==


<nowiki>{{file|filename|language|contents}}</nowiki>
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.


See documentation about <code>&lt;syntaxhighlight></code> for supported languages.
{{code|lang=mediawiki|line=no|<nowiki>
 
{{file|main.c|c|
  <nowiki>{{file|main.c|c|
</nowiki><<nowiki>nowiki</nowiki>><nowiki>
#include <stdio.h>
#include </nowiki><<nowiki>stdio.h</nowiki>><nowiki>


main( )
main( )
Line 24: Line 24:
         printf("hello, world\n");
         printf("hello, world\n");
}
}
</nowiki></<nowiki>nowiki</nowiki>><nowiki>
}}</nowiki>
}}</nowiki>
}}
<includeonly>
=== Template data ===


== Example ==
<templatedata>
{{file|main.c|c|
#include <stdio.h>
 
main( )
{
{
        printf("hello, world\n");
  "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 17:12, 11 June 2025

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

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