Template:Cite GitHub: Difference between revisions

Revision as of 22:09, 9 September 2024

{{{title}}} in {{{org}}}/{{{repo}}}

Template documentation[view] [edit] [history] [purge]

Cite GitHub.

Use this to Cite GitHub.

Cites a GitHub commit or file.

Template parameters[Edit template data]
Parameter		Description	Type	Status
URL	`url`	The URL to the resource. Example https://github.com/Chew/MLB-GameFeed-Bot/blob/875f62c510ba9703ccbe2d285d046930372203ba/src/main/java/pw/chew/mlb/MLBBot.java	URL	required
Title	`title`	The title of the file, commit, etc. Example MLBBot.java	String	required
Author	`author`	The author of the commit, if applicable.	String	optional
Org/User	`org`	Org/User of Repo Example The organization, or username, of the user/company who owns the repository linked.	String	required
Repository Name	`repo`	The name of the repository being cited. Example chew.pw	String	required
Type	`type`	The type of thing being cited. Currently just a commit or file. Suggested values `commit` `file`	String	required
Commit Hash	`commit`	The hash of the commit being referenced. Only required if the type is a commit.	String	required
Retrieved Date	`retrieved`	The date the file was retrieved. Not necessary if referencing a hash.	Date	suggested
Commit Date	`date`	The day the commit was committed.	Date	optional

The above documentation is transcluded from Template:Cite GitHub/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

@@ Line 1: / Line 1: @@
 {{#if: {{{url|}}} | [{{{url}}} {{{title}}}] | {{{title}}} }} {{#if: {{{author|}}} | by {{{author}}} }} in {{{org}}}/{{{repo}}}
-{{#if: {{{type|}}} | @ {{#if: {{{hash|}}} | {{{hash}}} | <code>{{{commit|}}}</code> }} on GitHub }}. Retrieved {{{retrieved}}}.
+{{#if: {{{type|}}} | {{#ifeq: {{{type}}}|commit| @ <code>{{{commit|}}}</code>}} }} {{#if: {{{date|}}} | , committed on {{{date}}} }} {{#if: {{{retrieved|}}} | . Retrieved {{{retrieved}}}. }}
 <noinclude>
 {{Documentation}}
 </noinclude>