Help:Editing manual: Difference between revisions
Jump to navigation
Jump to search
m (verification) |
m (add link to searching for bg3wiki article; update templates section) |
||
| Line 48: | Line 48: | ||
== Finding Wiki Content == | == Finding Wiki Content == | ||
=== Bypassing Google Search === | |||
See [[:Help:Searching for BG3Wiki]] for browser-specific instructions on how to more quickly and easily find wiki pages at any time. | |||
=== Searching Like a Boss === | === Searching Like a Boss === | ||
[[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 [[Special:Search|Search]] function is 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. | ||
* By default, Search results will only include content pages. | * By default, Search results will only include content pages. | ||
* Use the '''Multimedia''' option to search for images. | * Use the '''Multimedia''' option to search for images. | ||
| Line 85: | Line 87: | ||
== Templates == | == Templates == | ||
A '''Template''' is a special type of page designed to be included within other pages. Templates are often used as | 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. | ||
Templates are powerful tools and can become very complex. What follows is an extremely brief overview. For a much more in-depth look into templates, see [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates]. | Templates are powerful tools and can become very complex. What follows is an extremely brief overview. For a much more in-depth look into templates, see [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates]. | ||
=== Page Creation Templates === | === Page Creation Templates === | ||
We use templates like [[:Template:WeaponPage|WeaponPage | We use templates like [[:Template:WeaponPage|WeaponPage]] to maintain a clean, consistent style across a large number of pages that share similar properties, such as [[Spell]]s, [[Weapon]]s, and other [[Equipment]]. These templates take your input in the form of standard parameters and use it to generate a pre-formatted page, optimise the page for search engines and embedded social media links, and add the page to the appropriate categories. | ||
Examples: | |||
* {{SmallIcon|Worgfang Icon.png}}[[Worgfang]] and {{SmallIcon|Everburn Blade.png}}[[Everburn Blade]] were created using [[:Template:WeaponPage]] | |||
* {{SmallIcon|The Jolty Vest Icon.png}}[[The Jolty Vest]] and {{SmallIcon|Amulet of Lost Voices Icon.png}}[[The Amulet of Lost Voices]] were created using [[:Template:EquipmentPage]] | |||
* {{SmallIcon|Potion of Speed Icon.png}}[[Potion of Speed]], {{SmallIcon|Throwable_Smokepowder_Satchel_Icon.png}}[[Smokepowder Satchel]], and {{SmallIcon|Book NecromancyofThayUnsocketed.png}}[[Necromancy of Thay]] were created using [[:Template:MiscItemPage]] | |||
=== Other Templates === | === Other Templates === | ||
Other templates can be used in a more focused fashion to insert pre-formatted information or to add visual flair to a page, such as {{ | Other templates can be used in a more focused fashion to insert frequently used, pre-formatted information or to add visual flair to a page, such as <code><nowiki>{{MediumArmour}}</nowiki></code> ({{MediumArmour}}) or <code><nowiki>{{action|bonus}}</nowiki></code> ({{action|bonus}}). These types of templates are often embedded within other, larger templates like Page Creation Templates, but they can and should also be used on their own where appropriate. | ||
=== Using Templates === | === Using Templates === | ||
==== Add a Template to a Page ==== | ==== Add a Template to a Page ==== | ||
[[File:visual_editor_template.png|right|thumb|Inserting a template with the Visual Editor]] | [[File:visual_editor_template.png|right|thumb|Inserting a template with the Visual Editor]] | ||
* When using the Visual Editor, select '''Insert''' > '''Template''' from the toolbar and start typing a template name. The visual editor | * When using the Visual Editor, select '''Insert''' > '''Template''' from the toolbar and start typing a template name. The visual editor may not always display documentation for the template or its parameters, so be sure to open the template's page for usage information. | ||
* When using the Source Editor, you can either copy and paste template code from an existing page, or newly invoke a template you're already familiar with by enclosing the template name in {{code|<nowiki>{{double curly braces}}</nowiki>}}. For example: | * When using the Source Editor, you can either copy and paste template code from an existing page, or newly invoke a template you're already familiar with by enclosing the template name in {{code|<nowiki>{{double curly braces}}</nowiki>}}. For example: | ||
** Code: {{code|This attack has <nowiki>{{Advantage}}</nowiki>}} | ** Code: {{code|This attack has <nowiki>{{Advantage}}</nowiki>}} | ||
| Line 117: | Line 123: | ||
==== Template Documentation ==== | ==== Template Documentation ==== | ||
Template creators are encouraged to document (on the template's page) how to use that template, including usage examples and accepted values for any template parameters. If you're unfamiliar with a particular template, navigate to its page to learn how it works. If a template page does not show any usage instructions, it could still be a work in progress, and you may want to check with its creator before using it. | Template creators are encouraged to document (on the template's page itself as well as via the TemplateData button on the same page) how to use that template, including usage examples and accepted values for any template parameters. If you're unfamiliar with a particular template, navigate to its page to learn how it works. If a template page does not show any usage instructions, it could still be a work in progress, and you may want to check with its creator before using it. | ||
See [https://bg3.wiki/wiki/Special:AllPages?namespace=10 All Pages (Template namespace)] for a full list of available templates on bg3.wiki. | See [https://bg3.wiki/wiki/Special:AllPages?namespace=10 All Pages (Template namespace)] for a full list of available templates on bg3.wiki. | ||