Template:Project/Documentation: Difference between revisions

From Boktai Hacking Wiki
mNo edit summary
mNo edit summary
Line 17: Line 17:
| License || The license that applies to your project. || <code><nowiki>[https://spdx.org/licenses/MIT.html MIT]</nowiki></code>
| License || The license that applies to your project. || <code><nowiki>[https://spdx.org/licenses/MIT.html MIT]</nowiki></code>
|-
|-
| CreatedAt || Date on which project was initially released. || 2024-08-11
| ReleasedAt || Date on which project was initially released. || 2024-08-11
|-
|-
| UpdatedAt || Date on which the project was last updated. Omit if it hasn't been updated yet. || 2024-12-24
| UpdatedAt || Date on which the project was last updated. Omit if it hasn't been updated yet. || 2024-12-24
|-
|-
| Dependencies || If your project is a tool, and it requires dependencies to work, list them here. || Python
| Dependencies || If your project is a tool, and it requires dependencies to work, list them here. || Python
|-
| Homepage || Link to your project's homepage. || https://example.com
|-
|-
| Download || Download link to your project. Can also be a link to a file on this Wiki. || https://example.org/foo.ups
| Download || Download link to your project. Can also be a link to a file on this Wiki. || https://example.org/foo.ups
|-
| Homepage || Link to your project's homepage. || https://example.com
|}
|}


Line 38: Line 38:
| Author=[[User:Raphi|]]
| Author=[[User:Raphi|]]
| License=[https://spdx.org/licenses/MIT.html MIT]
| License=[https://spdx.org/licenses/MIT.html MIT]
| CreatedAt=2024-08-11
| ReleasedAt=2024-08-11
| UpdatedAt=2024-12-24
| UpdatedAt=2024-12-24
| Dependencies=Python
| Dependencies=Python
| Download=https://boktaihacking.net
| Homepage=https://boktaihacking.net
| Homepage=https://boktaihacking.net
| Download=https://boktaihacking.net/foo.ips
}}
}}
</syntaxhighlight>
</syntaxhighlight>
Line 54: Line 54:
| Author=[[User:Raphi|Raphi]]
| Author=[[User:Raphi|Raphi]]
| License=[https://spdx.org/licenses/MIT.html MIT]
| License=[https://spdx.org/licenses/MIT.html MIT]
| CreatedAt=2024-08-11
| ReleasedAt=2024-08-11
| UpdatedAt=2024-12-24
| UpdatedAt=2024-12-24
| Dependencies=Python
| Dependencies=Python
| Download=https://boktaihacking.net
| Homepage=https://boktaihacking.net
| Homepage=https://boktaihacking.net
| Download=https://boktaihacking.net/foo.ips
}}
}}

Revision as of 15:08, 12 August 2024

Use this template to highlight the most important information about your romhack (or romhacking resource/tool). Almost all parameters are optional, just set whichever ones are relvant to your project. Unless specified otherwise, all parameters are arbitrary wikitext.

Parameter Description Example wikitext
Type Required. Either Romhack or Tool. Romhack
ShortDescription Required. One brief sentence that describes your project. Sacrifices Boks for the greater good.
Image File name of an image/screenshot to show. Translation patch screenshot.png
TargetROM Which ROM(s) your project is compatible with Boktai 1 (U)
Author The people who made the project. Probably you. [[User:YourUserName|]]
License The license that applies to your project. [https://spdx.org/licenses/MIT.html MIT]
ReleasedAt Date on which project was initially released. 2024-08-11
UpdatedAt Date on which the project was last updated. Omit if it hasn't been updated yet. 2024-12-24
Dependencies If your project is a tool, and it requires dependencies to work, list them here. Python
Homepage Link to your project's homepage. https://example.com
Download Download link to your project. Can also be a link to a file on this Wiki. https://example.org/foo.ups

Example:

{{Project
| Type=Tool
| ShortDescription=Sacrifices Boks for the greater good.
| Image=Translation patch screenshot.png
| TargetROM=Boktai 1 (U)
| Author=[[User:Raphi|]]
| License=[https://spdx.org/licenses/MIT.html MIT]
| ReleasedAt=2024-08-11
| UpdatedAt=2024-12-24
| Dependencies=Python
| Homepage=https://boktaihacking.net
| Download=https://boktaihacking.net/foo.ips
}}

results in:

Project/Documentation
DescriptionSacrifices Boks for the greater good.
Target ROMBoktai 1 (U)
AuthorRaphi
LicenseMIT
DependenciesPython
Released at2024-08-11
Updated at2024-12-24
Homepagehttps://boktaihacking.net
Downloadhttps://boktaihacking.net/foo.ips