Difference between revisions of "Tutorial: Registering Extensions"
Tag: 2017 source edit |
|||
| Line 4: | Line 4: | ||
# Fork {{Github|user=corowne}} | # Fork {{Github|user=corowne}} | ||
| − | # Push your modifications as a branch | + | |
| − | ## These should be isolated from any others; that is, only changes which pertain to the extension itself should be included in the branch. | + | #Push your modifications as a branch |
| − | # Additionally, you should [[Special:CreateAccount|register]] for an account on this wiki! | + | ##These should be isolated from any others; that is, only changes which pertain to the extension itself should be included in the branch. |
| + | #Additionally, you should [[Special:CreateAccount|register]] for an account on this wiki! | ||
| + | #Browse the [[:Category:Extensions|Extensions category]] and choose a unique name for your extension. | ||
==Creating an Extension Page== | ==Creating an Extension Page== | ||
| − | Begin by entering the name of your extension, prefixed by <code>Extensions:</code>, into the search bar. | + | Begin by entering the name of your extension, prefixed by <code>Extensions:</code>, into the search bar. For example, Extensions:Separate Prompts. |
| + | |||
| + | This should bring you to a search results page stating that there is no page with that title present on the wiki. The title will be present as a red link; click this to be brought to page creation. | ||
| + | |||
| + | The page will then preload with the following: <code>{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}} | ||
| + | <!-- Put a short summary of your extension here! --> | ||
| + | == Installation == | ||
| + | <!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. --> | ||
| + | == Configuration == | ||
| + | <!-- Is any configuration necessary? Describe it here! --> | ||
| + | == Usage == | ||
| + | <!-- Is there anything users should know about using your extension? --> | ||
| + | == Troubleshooting == | ||
| + | <!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? --> | ||
| + | == See Also == | ||
| + | <!-- Any relevant other pages. You may consider linking to related extensions, for instance. --></code>. | ||
| + | |||
| + | When the page is saved, this will apply the [[Template:Extension Page|Extension page template]] to it. To do so, enter and delete a space or something to that effect, then click "Save changes..." at the top right. The page will then be created with the full page template. | ||
| + | |||
| + | == Filling out the page == | ||
| + | Click "Edit source" in the top right of the page. This will bring you to the editing dialogue. | ||
| + | |||
| + | First, consider filling out the infobox. Information about the template can be found at [[Template:Extensioninfobox]]. | ||
| + | |||
| + | Most of the body of the page should be self-explanatory; comments are also provided as prompts for each section. | ||
Revision as of 09:53, 11 June 2020
This is a tutorial on how to add your add-ons and extensions to Lorekeeper to this wiki.
Contents
Before you begin
- Fork corowne/lorekeeper
- Push your modifications as a branch
- These should be isolated from any others; that is, only changes which pertain to the extension itself should be included in the branch.
- Additionally, you should register for an account on this wiki!
- Browse the Extensions category and choose a unique name for your extension.
Creating an Extension Page
Begin by entering the name of your extension, prefixed by Extensions:, into the search bar. For example, Extensions:Separate Prompts.
This should bring you to a search results page stating that there is no page with that title present on the wiki. The title will be present as a red link; click this to be brought to page creation.
The page will then preload with the following:
the extension's name Description
A short description Author(s)
Author(s) Status
status (such as WIP, testing, stable) Github
branch LK Version
Unspecified
Installation
Configuration
Usage
Troubleshooting
See Also
.
When the page is saved, this will apply the Extension page template to it. To do so, enter and delete a space or something to that effect, then click "Save changes..." at the top right. The page will then be created with the full page template.
Filling out the page
Click "Edit source" in the top right of the page. This will bring you to the editing dialogue.
First, consider filling out the infobox. Information about the template can be found at Template:Extensioninfobox.
Most of the body of the page should be self-explanatory; comments are also provided as prompts for each section.
