Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Help:Editing basics: Difference between revisions

Help page
Willowisp (talk | contribs)
No edit summary
Internal linking: Added details for linking to Category pages
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{NavWiki|help}}
{{NavWiki|help}}
{{nav button|right|Help:Using templates|Using templates|noclear=1|padding=1%}}
The markup language used on the wiki is called ''wikitext''. Most articles on BG3Wiki can be edited either by directly manipulating wikitext via the ''source editor'', or by using the ''visual Editor'', which functions as a word processor.
{{nav button|left|Help: Getting started|Getting started|noclear=1|padding=1%}}
{{TocHelp}}
This article will teach you the '''basics of editing''' BG3Wiki. Most articles on BG3Wiki can be edited by either directly manipulating [https://www.mediawiki.org/wiki/Help:Formatting wikitext] via the ''Source Editor'', or by using the ''Visual Editor'', which functions as a word proccessor, allowing for a more visually intuitive means of editing wikitext. However, it cannot directly manipulate wiki markup.


== How to edit ==
Most of the information in this manual will be explained using wikitext, but it applies to both the source editor and the visual editor.
 
== Page tabs ==
=== Edit ===
<gallery>
<gallery>
File:edit_visual_or_source.png|right|thumb|150px|Visual Editor and Source Editor.
File:edit_visual_or_source.png|thumb|100px|Visual Editor and Source Editor.
File:switch_visual_or_source.png|right|thumb|150px|Switching between editor types.
File:switch_visual_or_source.png|thumb|100px|Switching between editor types.
</gallery>
</gallery>
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.
To edit an existing page, click either ''Edit'' (opens the visual editor) or ''Edit source'' (opens the source editor) above the page. Within either editor, 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. You can also preview any changes you've made before saving.
 
=== Discussion ===
An article's ''discussion'' page – or ''talk page'' – is used to settle disagreements about an article. Use an article's discussion page to discuss the article's contents and edits. Sign your comments using {{code|<nowiki>~~~~</nowiki>}}.
 
=== View history ===
Click the '''View history''' tab 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 possibly a summary for the edit.
 
== Linking ==
=== Internal linking ===
Internal links (links to other BG3Wiki articles) are added using double square brackets {{code|<nowiki>[[...]]</nowiki>}}. A pipe {{code|<nowiki>|</nowiki>}} can be placed after the name of the target article, and followed with a text to display in its place. For example, {{code|<nowiki>[[Help: Style Guide|Style Guide]]</nowiki>}} appears as [[Help:Style Guide|Style Guide]].
 
To link to a [[Help:Categories|Category]], add a colon  {{code|<nowiki>:</nowiki>}} at the start, such as {{code|<nowiki>[[:Category:Areas]]</nowiki>}}. Without this, the page will instead be marked as being in that category.
 
Links can be used to display images as well. See [https://www.mediawiki.org/wiki/Help:Images Help:Images on MediaWiki] for further instructions.
 
=== External links ===
External links (to other websites) are added by enclosing the URL followed by a Space then the Link Text within single square brackets {{code|<nowiki>[URL LinkText]</nowiki>}}. For example, {{code|<nowiki>[https://www.mediawiki.org/wiki/Help:Links MediaWiki Help - Links]</nowiki>}} appears as [https://www.mediawiki.org/wiki/Help:Links MediaWiki Help - Links].
 
For commonly referenced sites such as the Forgotten Realms wiki, Wikipedia, or IMDB, use a premade [[:Category:External link templates|External Link Template]] for it.
 
== Templates ==
{{hatnote|For a list of all commonly used templates, see [[Help:List of templates]].}}
A ''template'' is a special type of page designed to be included within other pages. Templates are used extensively on BG3Wiki.


When you've finished editing, feel free to add a brief ''summary'' of your changes and click the ''save changes'' button.
The [[Help:Using templates|next step]] of this manual will cover specific uses of templates.


==== Discussion pages ====
=== Adding templates using the visual editor ===
An article's '''Discussion''' page, or Talk Page is used to settle disagreements about an article. Use an article's Discussion page to discuss the article's contents and edits. Sign your comments using {{code|<nowiki>~~~~</nowiki>}}.
[[File:visual_editor_template.png|right|thumb|Inserting a template with the Visual Editor]]
Templates can be searched for and added via the toolbar above the visual editor by clicking ''Insert'', and in the dropdown box, selecting ''Templates''. Most templates can be easily inserted onto a page this way. To later edit its contents, simply click on the inserted template in the visual editor for options.


==== Page history ====
=== Adding templates using the source editor ===
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.
Templates are added by using double brackets {{code|<nowiki>{{ ... }}</nowiki>}}. For example, the template {{code|foo}} is added by typing {{code|<nowiki>{{foo}}</nowiki>}}.


== How to use categories ==
A template's parameters are specified through the use of pipes {{code|<nowiki>|</nowiki>}}.
[[File:category_example.png|right|thumb|Example of a Category]]
 
'''[[Special:Categories|Category]]''' pages list all the pages within that Category.
* Template with one parameter:
** Code: {{code|<nowiki>{{enchantment|+1}}</nowiki>}}
** Result: {{enchantment|+1}}
* Template with multiple parameters:
** Code: {{code|<nowiki>{{AttributeBlock|8|15|7|6|10|8|dex save = yes|race=Bird|hp=10}}</nowiki>}}
** Result:
{{AttributeBlock|8|15|7|6|10|8|dex save = yes|race=Bird|hp=10}}
 
== Categories ==
[[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.
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.
 
<gallery>
File:visual_editor_categories.png|thumb|150px|Adding categories in Visual Editor.
File:category_example.png|thumb|150px|Example of a category page.
</gallery>


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


Line 35: Line 72:
* 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.
* 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.


== How to create a new page ==
== Creating new pages ==
A new page can be created simply by opening a link to a page that have yet to be created, such as by clicking a red link, or by searching for the page on the wiki. If it doesn't yet exist, it can be created. Most pages on BG3Wiki are created with the help of templates, which may seem daunting at first, but they are actually quite easy to use.
A new page can be created simply by opening a link to a page that have yet to be created, such as by clicking a red link, or by searching for the page on the wiki. If it doesn't yet exist, it can be created. Most pages on BG3Wiki are created with the help of templates, which may seem daunting at first, but they are actually quite easy to use.


==== Creating redirects ====
=== Creating redirects ===
If a page exists but users may search for it using multiple terms, a redirect page can be created using {{code|<nowiki>#REDIRECT [[article link]]</nowiki>}}.
If a page exists but users may search for it using multiple terms, a redirect page can be created using {{code|<nowiki>#REDIRECT [[article link]]</nowiki>}}.
== 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. Templates are used extensively on BG3Wiki, and a basic understanding of how to use templates is often necessary to create new pages. Luckily, using templates is easy, and the next step of this guide [[Help:Using templates|Using templates]] will cover the basics of template usage on BG3Wiki.


== Additional resources ==
== Additional resources ==