Help:How to contribute: Difference between revisions
(Willowisp moved page Help:How to contribute to Help:Getting started) Tag: New redirect |
(Removed redirect to Help:Getting started) Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
{{NavWiki}} | |||
{{PageSeo | |||
| image = bg3wiki_help.png | |||
| description = A brief guide on how to contribute to the Baldur's Gate 3 Community Wiki | |||
}} | |||
'''BG3Wiki''' is a community volunteer effort. | |||
Everything here is written and maintained by fans of the game. Anyone can edit and contribute to BG3Wiki, no sign-up necessary! | |||
This page will help you get started on contributing to the wiki. If you're interested in diving deeper into a particular topic, check out the various available online. | |||
== Getting started == | |||
Don't be afraid to contribute to the wiki. Contributions are always welcome, and you're encouraged to add any missing information. | |||
If you want guidance on best practices, you can at any time consult the [[Help:Editing Policy|Editing Policy]] or the [[Help:Style Guide|Style Guide]], but this is not required to get started! | |||
==== Creating an account ==== | |||
[[Special:CreateAccount|Creating an account]] is an optional step that allows you to customize your wiki settings and attributes wiki edits to your account. You can edit pages without an account, but your IP address will be publicly logged. | |||
==== Sandboxes ==== | |||
[[Special:MyPage/Sandbox|Click Here]] to create your personal sandbox page. You can use this to learn how to edit, or simply to experiment. You are free to edit this page as much as you wish, it is disconnected from the rest of the wiki. | |||
==== Discussion pages ==== | |||
An article's '''Discussion''' page, or Talk Page, is where editors can discuss an article. Use an article's Discussion page to discuss the article's contents and edits. Sign your comments using {{code|<nowiki>~~~~</nowiki>}}. | |||
==== Page history ==== | |||
Click the '''View history''' button above a page to see a history of edits performed on that page. Each line describes a revision of the page, including date/time, the contributor who made that edit, and (ideally) the reason for the edit. This can be helpful if you're not sure why an edit was made. | |||
The wiki is a living project, and wiki editing is a collaborative effort! Be prepared for your contributions to be tweaked, copyedited, or deleted. | |||
=== Introduction to editing === | |||
==== Editing an existing page ==== | |||
To edit an existing page, click either '''Edit''' (opens Visual Editor) or '''Edit source''' (opens Source Editor) above the page. Within either editor view, you can switch between the Visual Editor and the Source Editor at any time via the upper-right menu button. | |||
When you've finished editing, feel free to add a brief '''Summary''' of your changes and click the '''Save changes''' button! | |||
[[File:edit_visual_or_source.png|right|thumb|Visual Editor and Source Editor buttons]] | |||
[[File:switch_visual_or_source.png|right|thumb|Switching between editor types]] | |||
* The Visual Editor is helpful for contributors who are new or not yet familiar with [https://www.mediawiki.org/wiki/Help:Formatting wiki markup], but it doesn't allow you to directly manipulate wiki markup. | |||
* The Source Editor is more powerful and flexible, but requires at least a basic understanding of wiki markup. | |||
==== Categories ==== | |||
[[File:category_example.png|right|thumb|Example of a Category]] | |||
'''[[Special:Categories|Category]]''' pages list all the pages within that Category. | |||
==== Browsing categories ==== | |||
The '''Everything''' search option includes Categories in the search results. You can also find them on the [[Special:Categories]] page. Categories can prove useful when looking for a specific image or page, particularly when you don't know the exact name of the thing you're looking for. | |||
==== Adding a page to a category ==== | |||
[[File:visual_editor_categories.png|right|thumb|Adding Categories in the Visual Editor]] | |||
Some templates will automatically add the correct category to the page it is used on. However, in some cases, you'll want to manually add pages to additional categories. | |||
To add a page to a category: | |||
* When using the Visual Editor, you can add a page to a category by clicking on the upper-right menu and selecting '''Categories'''. Start typing a category name in the provided box, and the editor will suggest autocomplete options for the category, if any exist. | |||
* When using the Source Editor, use the markup {{code|<nowiki>[[</nowiki>Category:<em>Name of category here</em><nowiki>]]</nowiki>}} at the bottom of the page. You can repeat this as many times as needed for additional Categories. | |||
=== Templates === | |||
{{hatnote|See also: [[Help:Templates]]}} | |||
A Template is a special type of page designed to be included within other pages. Templates are often used as 'shorthand' to automatically insert frequently-used images, code, and formatting on a page. We use templates extensively on bg3.wiki. | |||
See the [[Help:Template Quick Reference|Template Quick Reference]] for an overview of the most commonly-used templates. | |||
== Using the search feature == | |||
{{hatnote|See also: [[Help:Searching for BG3Wiki]]}} | |||
[[File:multimedia_search.png|right|thumb|Use the Multimedia option to search for images]] | |||
The built-in [[Special:Search|Search]] function is also very powerful. You can use it to find pages, images, categories, templates, and more. | |||
* By default, Search results will only include content pages. | |||
* Use the '''Multimedia''' option to search for images. | |||
* Use the '''Everything''' option for a quick-and-dirty way to look through all possible results for your search term. | |||
* Use the '''Advanced''' option to filter your search to specific [https://www.mediawiki.org/wiki/Help:Namespaces namespaces], like Category or Template. | |||
== Other namespaces == | |||
=== Guides === | |||
{{hatnote|See also: [[Help:Guide namespace]]}} | |||
The Guide namespace is where users can create and edit guides on BG3Wiki. These pages use different rules from the rest of the wiki. | |||
To create a Guide, simply start an article name with {{code|Guide:}}. For example, {{code|Guide:How to use torches}}. | |||
== Additional resources == | |||
* [https://www.mediawiki.org/wiki/Help:Contents MediaWiki help pages] | |||
* [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki formatting] | |||
* [[Help:Editing Policy|Editing Policy]] | |||
* [[Help: Style Guide|Style Guide]] | |||
== Discord == | |||
Join the [https://discord.gg/K6R89fSZuF BG3Wiki Discord] to discuss wiki editing with other bg3.wiki contributors! Or, if you prefer not to join the Discord, you can leave messages via the '''Discussion''' link at the top of any page (including any user's page, if you want to contact them). | |||
[[Category:Wiki Help]] | |||
Revision as of 09:05, 18 October 2023
BG3Wiki is a community volunteer effort.
Everything here is written and maintained by fans of the game. Anyone can edit and contribute to BG3Wiki, no sign-up necessary!
This page will help you get started on contributing to the wiki. If you're interested in diving deeper into a particular topic, check out the various available online.
Getting started
Don't be afraid to contribute to the wiki. Contributions are always welcome, and you're encouraged to add any missing information.
If you want guidance on best practices, you can at any time consult the Editing Policy or the Style Guide, but this is not required to get started!
Creating an account
Creating an account is an optional step that allows you to customize your wiki settings and attributes wiki edits to your account. You can edit pages without an account, but your IP address will be publicly logged.
Sandboxes
Click Here to create your personal sandbox page. You can use this to learn how to edit, or simply to experiment. You are free to edit this page as much as you wish, it is disconnected from the rest of the wiki.
Discussion pages
An article's Discussion page, or Talk Page, is where editors can discuss an article. Use an article's Discussion page to discuss the article's contents and edits. Sign your comments using ~~~~.
Page history
Click the View history button above a page to see a history of edits performed on that page. Each line describes a revision of the page, including date/time, the contributor who made that edit, and (ideally) the reason for the edit. This can be helpful if you're not sure why an edit was made.
The wiki is a living project, and wiki editing is a collaborative effort! Be prepared for your contributions to be tweaked, copyedited, or deleted.
Introduction to editing
Editing an existing page
To edit an existing page, click either Edit (opens Visual Editor) or Edit source (opens Source Editor) above the page. Within either editor view, you can switch between the Visual Editor and the Source Editor at any time via the upper-right menu button.
When you've finished editing, feel free to add a brief Summary of your changes and click the Save changes button!
- The Visual Editor is helpful for contributors who are new or not yet familiar with wiki markup, but it doesn't allow you to directly manipulate wiki markup.
- The Source Editor is more powerful and flexible, but requires at least a basic understanding of wiki markup.
Categories
Category pages list all the pages within that Category.
Browsing categories
The Everything search option includes Categories in the search results. You can also find them on the Special:Categories page. Categories can prove useful when looking for a specific image or page, particularly when you don't know the exact name of the thing you're looking for.
Adding a page to a category
Some templates will automatically add the correct category to the page it is used on. However, in some cases, you'll want to manually add pages to additional categories.
To add a page to a category:
- When using the Visual Editor, you can add a page to a category by clicking on the upper-right menu and selecting Categories. Start typing a category name in the provided box, and the editor will suggest autocomplete options for the category, if any exist.
- When using the Source Editor, use the markup
[[Category:Name of category here]]at the bottom of the page. You can repeat this as many times as needed for additional Categories.
Templates
A Template is a special type of page designed to be included within other pages. Templates are often used as 'shorthand' to automatically insert frequently-used images, code, and formatting on a page. We use templates extensively on bg3.wiki.
See the Template Quick Reference for an overview of the most commonly-used templates.
Using the search feature
The built-in Search function is also very powerful. You can use it to find pages, images, categories, templates, and more.
- By default, Search results will only include content pages.
- Use the Multimedia option to search for images.
- Use the Everything option for a quick-and-dirty way to look through all possible results for your search term.
- Use the Advanced option to filter your search to specific namespaces, like Category or Template.
Other namespaces
Guides
The Guide namespace is where users can create and edit guides on BG3Wiki. These pages use different rules from the rest of the wiki.
To create a Guide, simply start an article name with Guide:. For example, Guide:How to use torches.
Additional resources
Discord
Join the BG3Wiki Discord to discuss wiki editing with other bg3.wiki contributors! Or, if you prefer not to join the Discord, you can leave messages via the Discussion link at the top of any page (including any user's page, if you want to contact them).