Help:Style guide

From binaryoption
Jump to navigation Jump to search
Баннер1
  1. Help:Style guide

This page provides a comprehensive style guide for contributing to this wiki. Following these guidelines ensures consistency, readability, and a professional appearance across all articles. It’s intended for both new and experienced editors. This guide covers aspects of writing style, formatting, and structural elements within the MediaWiki environment. Consistency is key; when in doubt, look at existing, well-written articles for examples of how to handle specific situations.

General Principles

The primary goal of all articles is to convey information clearly and accurately. Assume your readers have varying levels of knowledge on the subject. Strive for neutrality and avoid expressing personal opinions. Focus on verifiable facts and cite your sources appropriately. Avoid jargon where possible, and when unavoidable, explain it thoroughly. Remember this is a collaborative project, and constructive criticism is expected. Maintain a respectful tone in all discussions and edits.

Voice and Tone

  • Neutral Point of View (NPOV): All articles must be written from a neutral point of view. Avoid biased language or framing that favors one perspective over another. Present all sides of an argument fairly and objectively. See Help:Neutral point of view for more details.
  • Formal Tone: Maintain a formal and professional tone. Avoid slang, colloquialisms, and overly casual language.
  • Conciseness: Be concise and to the point. Avoid unnecessary words or phrases. Every sentence should contribute to the overall understanding of the topic.
  • Accuracy: Accuracy is paramount. Double-check all facts and figures before including them in an article. Provide reliable sources to support your claims.
  • Clarity: Write in clear, simple language. Avoid complex sentence structures and ambiguous wording.

Audience

Consider the intended audience: individuals new to the subject matter. Explanations should be thorough but not condescending. Avoid assuming prior knowledge. Use examples and analogies to illustrate complex concepts. Link to relevant articles within the wiki for further reading.

Formatting

MediaWiki uses a specific markup language for formatting. Understanding these basics is crucial for creating well-structured and visually appealing articles.

Headings

Use headings to organize your content logically. Headings also improve readability and allow readers to quickly scan the article.

  • `= Heading 1 =` (Main title)
  • `== Heading 2 ==` (Section heading)
  • `=== Heading 3 ===` (Subsection heading)
  • `==== Heading 4 ==== `(Sub-subsection heading)
  • And so on, up to Heading 6.

Text Formatting

  • Bold text: Use three single quotes (`text`) to emphasize important terms or phrases.
  • Italic text: Use two single quotes (`text`) for book titles, foreign words, or to indicate a specific emphasis.
  • Monospace text: Use angle brackets (`text`) for code snippets or technical terms.
  • Underlined text: Use HTML tags `text` for underlining. Use sparingly.
  • ~~Strikethrough text:~~ Use two tildes (`~~text~~`) to indicate deleted or outdated information.

Lists

  • Unordered lists: Use asterisks (`*`) to create bulleted lists.
   *   Item 1
   *   Item 2
   *   Item 3
  • Ordered lists: Use hash marks (`#`) to create numbered lists.
   #   Step 1
   #   Step 2
   #   Step 3
  • Definition lists: Use a colon (`:`) to define terms.
   : Term 1
   : Definition of Term 1

Links

  • Internal links: Use double square brackets (`Article Name`) to link to other articles within the wiki. For example: Help:Contents. This is essential for creating a cohesive knowledge base. See Help:Linking for more details.
  • External links: Use square brackets (`Example Website`) to link to external websites. Ensure the linked website is reliable and relevant to the article's content.
  • Anchor links: Link to specific sections within an article using `#Section Name`. For example: #Formatting.
  • Wiki links: Use double square brackets around a word or phrase to create a link to another wiki page.

Tables

Tables are useful for presenting data in a structured format. The following is a basic table example:

```wiki

Caption for the table
Header 1 Header 2 Header 3
Row 1, Cell 1 Row 1, Cell 2 Row 1, Cell 3
Row 2, Cell 1 Row 2, Cell 2 Row 2, Cell 3

```

Images

Images can enhance the visual appeal of an article and help illustrate complex concepts.

```wiki

File:Example.jpg
Caption for the image

```

Where:

  • `Example.jpg` is the filename of the image.
  • `thumb` creates a thumbnail.
  • `200px` sets the width of the thumbnail.
  • `Caption for the image` is the text that appears below the image.

Blockquotes

Use blockquotes to highlight quotations or excerpts from other sources.

```wiki > This is a blockquote. It is used to emphasize text from another source. ```

Horizontal Rules

Use horizontal rules to visually separate sections of an article.

```wiki --- ```

Specific Style Considerations

These guidelines address specific aspects of writing about financial and trading topics.

Terminology

  • **Define terms:** Always define technical terms when they are first used. For example, explain what a "bull market" or "bear market" is. Link to articles that provide more detailed explanations.
  • **Consistency:** Use consistent terminology throughout the article. Avoid using multiple terms to refer to the same concept.
  • **Avoid Jargon:** Minimize the use of jargon, especially when writing for beginners. When jargon is unavoidable, provide a clear explanation.

Numbers and Units

  • **Currency:** Use the appropriate currency symbol (e.g., $, €, ¥) and specify the currency.
  • **Percentages:** Express percentages using the % symbol (e.g., 50%).
  • **Dates:** Use a consistent date format (e.g., YYYY-MM-DD).
  • **Rounding:** Round numbers to a reasonable level of precision.

Mathematical Formulas

Use LaTeX formatting for mathematical formulas. Surround the formula with `$` for inline formulas and `$$` for displayed formulas. For example:

`$E(X) = \mu$` (Inline)

`$$E(X) = \mu$$` (Displayed)

Example Topics and Related Links

Here are some example topics and related links to illustrate how to integrate internal and external resources:

Disclaimers

Always include a disclaimer stating that trading involves risk and that past performance is not indicative of future results. For example:

  • "Disclaimer: Trading financial instruments involves significant risk and may not be suitable for all investors. Past performance is not indicative of future results. Always seek professional advice before making any investment decisions."*

Editing Guidelines

  • **Preview:** Always preview your edits before saving them to ensure they are formatted correctly.
  • **Edit Summary:** Provide a concise and informative edit summary explaining the changes you made.
  • **Talk Pages:** Use the article's talk page (Talk:Article Name) to discuss proposed changes or resolve disputes.
  • **Be Respectful:** Maintain a respectful tone in all discussions.
  • **Collaboration:** Be open to collaboration and feedback from other editors.

Resources

Start Trading Now

Sign up at IQ Option (Minimum deposit $10) Open an account at Pocket Option (Minimum deposit $5)

Join Our Community

Subscribe to our Telegram channel @strategybin to receive: ✓ Daily trading signals ✓ Exclusive strategy analysis ✓ Market trend alerts ✓ Educational materials for beginners

Баннер
Retrieved from "https://binaryoption.wiki/index.php?title=Help:Style_guide&oldid=43055"