Help:Compact Guide for Editors/Template basics

From Moegirlpedia
Revision as of 15:51, 28 February 2024 by 6116G (talk | contribs)
Jump to: navigation, search
A Compact Guide for Editors of Moegirlpedia

WelcomeFirst editTemplate basicsCommunity


What is a template?

If a piece of content or code needs to be used a lot (top banners, character information, etc.), a template will be created to make it easier to be referenced and edited. Give this content a name, and call it directly when needed. The content only needs to be changed in the template, and entries with it will also change, saving lots of maintenance time. If you have edited an article, you may notice code like {{content}}, which is a template, and in the source code, {{template name|template parameter}}, to enclose the template with a pair of double curly brackets, and use the pipe character "|" to separate the name and parameters, is the basic form of a template.

Simply put, calling the template is to fill in the blanks. The parameters are the prompt words in parentheses, and the parameter values are the answers you fill. Note that parameters cannot be increased just by using a template. For easier check, maintenance, (and acceptance from OCD), parameters with much content in a template are usually separated with line breaks or spaces, like:

{{font
|color = red
|size = 20px
|Welcome to Moegirlpedia!
}}

The word "font" in the above code is the name of the template; words between "|" and "=" like "color" and "size", are template parameters; words after "=" like "red" and "20px" are parameter values. A parameter value can be empty. Templates mostly ignore spaces and line breaks at the beginning and end of parameters, so they rarely affects the output.

Some templates quote parameters that don't use "=" but numbers like "1" and "2" (so-called "anonymous parameters"), like: {{color|white|You can't see me!}}. In the example, "white" and "You can't see me!" are the parameter values of the template. These parameters can also be written in their equivalent: {{color|1=white|2=You can't see me!}}. In fact, changing to a named parameter can solve the error caused when the parameter value contains HTML tags or "=".

Still confused? It doesn't matter, because templates are the most complex and difficult part to understand when getting started with Wikitext, and this section is just a general introduction of templates. We believe you will gradually understand in later study and practice. If you see a templates or parameter that you don't understand anywhere, to prevent errors in the call, please search for the template page typing its name like "Template:name" and check its documentation, to learn its parameters and how to use, otherwise do not use the template or parameters lightly.

Common templates

The following will only introduce the basic usage of a few common templates. You can also click the template link and check their documentation to master advanced usage.

  • {{Color}}: Colored text. Parameter 1 for the color (HTML colors supported, see Help:List of colors), and parameter 2 for the text, both of which are mandatory.
    • Example: {{color|red|It is red.}}It is red.
  • {{Font}}: Text with various font effects. It has many parameters. Size specifies the size of the text; color for its color (similar to Template:color); bgcolor for its background color; shadowcolor for its shadow color; and title specifies the prompt when the mouse hovered on the text.
    • Example: {{font|color=red|size=20px|title=Welcome to Moegirlpedia!|Welcome!}}Welcome!
  • {{Ruby}}: Denoting phonetics. Parameter 1 for the text, parameter 2 for its phonetics, both of which are mandatory. Parameters 3 and 4 are optional.
    • Example: {{ruby|注|zhù}}{{ruby|音|yīn}} (Chinese characters to Pinyin)zhùyīn
  • {{lj}}, {{lang-ja}}: Denoting Japanese, usually to distinguish similar characters from Chinese. Just one parameter for the text and {{lang-ja}} would bring an additional "Japanese: " before it.
    • Example: The sentence "Good morning" in Japanese is {{lj|おはよう}}, and "Good afternoon" {{lj|こんにちは}}, while "Good evening" in {{lang-ja|こんばんは}}. → The sentence "Good morning" in Japanese is おはよう, and "Good afternoon" こんにちは, while "Good evening" in Japanese: こんばんは.
  • {{Spoiler}}: Text cover. The first mandatory parameter for the text covered, and the optional second for the prompt when the mouse hovered. However, do not use spoiler and strikethrough at the same time.
    • Example: {{Spoiler|Flat-tan is so cute!|Jeez...who allowed you to hover on it.}}Flat-tan is so cute!
  • {{Hide}}: Collapsed text. Parameter Title for the title, and Text for the text to hide.
    • Example: {{Hide|Title=Click the "Expand" on the right.|Text=The text hidden would be shown.}}
Click the "Expand" on the right.

The text hidden will be shown.

More templates are listed on page Category:Templates, and you can seek Help:Templates or MGP:Template guidelines for more help, like how to create a template.

Layout of articles

Moegirlpedia has consensus on the layout, and entries not meeting it need to be localized to conform to the layout regulations.

  • Naming of articles. Please follow these priority principles, to make their names official, common, English, full-named, and special-symbols avoided. For detailed requirements and other special cases, please refer to the article naming guidelines.
  • Before preface. A preface refers to the summary of an article above the first 2nd level heading, which should follow the below:
    • Disambiguation templates. Names of some articles may be confusing to readers because of polysemy or their high similarity, so when this ambiguity occurs, a disambiguation template is needed to eliminate it. The most common templates are {{About}}, {{Distinguish}}, {{Otheruseslist}}, etc.
    • Infobox templates, also known as "infoboxes", are musts for all articles. Each of them typically contains a basic profile and relavant picture for an article, to help readers quickly identify the topic.
  • The bottoms of articles in Moegirlpedia, according to the convention, should generally consist of these parts: "Navigation boxes" (or "Navbox"), "Notes", "References" and "External links". The Navbox should be above the others without an exclusive 2nd level heading, while the remaining could be splitted or merged into "references" depending on how much the content is.

For further information, please click here to check the Chinese compact guide.