Help:Editing manual: Difference between revisions

Jump to navigation Jump to search
376 bytes removed ,  16 October 2023
no edit summary
No edit summary
Line 1: Line 1:
{{NavWiki}}
{{NavWiki}}
[[File:bg3wiki_help.png|thumb|right|Illithid wisdom sent you here...]]
{{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.
'''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!
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 [https://www.mediawiki.org/wiki/Help:Contents MediaWiki help pages] available online.
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.


An [[Help:Editing Policy|Editing Policy]] and a [[Help: Style Guide|Style Guide]] are also available. Reading any policies or guidelines is '''not required''' to edit BG3Wiki, but it may prove helpful.
== Getting 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 visit 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.


== Creating an account ==
=== Improving the wiki ===
[[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.
Don't be afraid to contribute to the wiki. Contributions are always welcome, and you're encouraged to add any missing information.


== Working with pages ==
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!
{{hatnote|See [https://www.mediawiki.org/wiki/Help:Contents MediaWiki Help:Contents] for overall MediaWiki help, or [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Help:Formatting] for detailed help with MediaWiki markup.}}


=== First-time editors ===
Use an article's Discussion page to discussing any articles and edit. Sign your articles using {{code|<nowiki>~~~~</nowiki>}}.
If you are anxious about editing a wiki for the first time, don't be. Contributions are always welcome, and you're encouraged to add any missing information. A wiki page is designed to be a malleable document that can easily be edited and corrected, and usually should be. Any mistakes can be corrected by another editor.  


If you want guidance on best practices, you may 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!
==== Edit 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.


If you are unsure about your edit for any reason, you can leave a relevant comment on the talk page, via the 'Discussion' tab at the top of any page you are editing, or ask for guidance in the wiki Discord server.
When you've finished editing, feel free to add a brief '''Summary''' of your changes and click the '''Save changes''' button!


=== Create a new page ===
==== Creating new pages ====
[[File:edit_visual_or_source.png|right|thumb|Visual Editor and Source Editor buttons]]
[[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]]
[[File:switch_visual_or_source.png|right|thumb|Switching between editor types]]
Line 30: Line 36:
* The Source Editor is more powerful and flexible, but requires at least a basic understanding of wiki markup.
* The Source Editor is more powerful and flexible, but requires at least a basic understanding of wiki markup.


=== Edit an existing page ===
=== Categories ===
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.
[[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.


When you've finished editing, feel free to add a brief '''Summary''' of your changes and click the '''Save changes''' button!
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.
{{clear}}
* 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.


=== Page history ===
=== 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.
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.


Remember: The wiki is a living project, and wiki editing is a collaborative effort! Be prepared for your contributions to be tweaked, copyedited, or deleted.
The wiki is a living project, and wiki editing is a collaborative effort! Be prepared for your contributions to be tweaked, copyedited, or deleted.


== Finding wiki content ==
== Using the search feature ==
=== Bypassing google search ===
{{hatnote|See also: [[Help:Searching for BG3Wiki]]}}
See [[:Help:Searching for BG3Wiki]] for browser-specific instructions on how to more quickly and easily find wiki pages at any time.
 
=== Using the search feature ===
[[File:multimedia_search.png|right|thumb|Use the Multimedia option to search for images]]
[[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.
The built-in [[Special:Search|Search]] function is also very powerful. You can use it to find pages, images, categories, templates, and more.
Line 53: Line 62:
* Use the '''Everything''' option for a quick-and-dirty way to look through all possible results for your search term.
* 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.
* Use the '''Advanced''' option to filter your search to specific [https://www.mediawiki.org/wiki/Help:Namespaces namespaces], like Category or Template.
{{clear}}


=== Categories ===
== Guides ==
[[File:category_example.png|right|thumb|Example of a Category]]
Adding {{code|<nowiki>Guide</nowiki>}} when making a page will allow you to make guides. Guides use different rules from the rest of thw wiki.
'''[[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:
== Additional resources ==
* 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.
* [https://www.mediawiki.org/wiki/Help:Contents MediaWiki help pages]
* 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.
* [https://www.mediawiki.org/wiki/Help:Contents MediaWiki Help:Contents]
{{clear}}
* [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Help:Formatting] for detailed help with MediaWiki markup.}}
* [[Help:Editing Policy|Editing Policy]]
* [[Help: Style Guide|Style Guide]]


== Additional resources ==
== 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).


Check out the [[Help:Style Guide|Style Guide]] for more information on style guidelines followed by bg3.wiki.


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).
{{PageSeo
| image = bg3wiki_help.png
| description = A brief guide on how to contribute to the Baldur's Gate 3 Community Wiki
}}
[[Category:Wiki Help]]
[[Category:Wiki Help]]
8,856
edits

Navigation menu