Help:Wiki editing View history

(→‎Table formatting: more sources)
(→‎Section headings: added a link to not using bold in headings)
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{construction|contact=http://www.waze.com/forum/viewforum.php?f=276 |contacttype=forum | draft=yes |open=no |talk=yes}}
{{Mbox | type=important| text=This article is not part of the Waze application, but rather a part of the Wiki editing guide. If you reached this page in error, please return to the [[Main Page|main page]] and start your search again. If you have suggestions for changes to this page, please visit [http://www.waze.com/forum/viewforum.php?f=276 this Wiki forum].}}
 
<br />
This article is not part of the Waze application, but rather a part of the Wiki editing guide. If you reached this page in error, please return to the [[Main Page|main page]] and start your search again.
----
== Editing ==
== Editing ==
To start this page, content will be linked from other sources until such time that the content can be created directly for the Waze Wiki. Many links will be provided from Wikipedia to expedite the help pages. If a topic is not found in the Waze Wiki, consider checking for a similar topic in the [http://en.wikipedia.org/wiki/Help:Contents/Directory Wikipedia Help Directory].
To start this page, content will be linked from other sources until such time that the content can be created directly for the Waze Wiki. Many links will be provided from Wikipedia to expedite the help pages. If a topic is not found in the Waze Wiki, consider checking for a similar topic in the [http://en.wikipedia.org/wiki/Help:Contents/Directory Wikipedia Help Directory].


=== Editing pages ===
=== Editing pages ===
[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Editing Editing pages]
* [http://en.wikipedia.org/wiki/Help:Cheatsheet Wiki markup - cheatsheet]
:* [http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki markup - detailed]
* [http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Editing Editing pages]


=== Text formatting ===
=== Text formatting ===
[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Formatting Formatting]<br>
* [http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Formatting Formatting]
[http://en.wikipedia.org/wiki/Wikipedia:Line-break_handling Line break handling]<br>
* [http://en.wikipedia.org/wiki/Wikipedia:Line-break_handling Line break handling]
[http://en.wikipedia.org/wiki/Wikipedia:Codes Codes for characters]<br>
* [http://en.wikipedia.org/wiki/Wikipedia:Codes Codes for characters]
{{tl|clear}} template<br>
* {{tl|clear}} template
{{tl|red}} template<br>
* {{tl|red}} template


=== Image formatting ===
=== Image formatting ===
[http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Extended image formatting]
* [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Extended image formatting]


=== Table formatting ===
=== Table formatting ===
Line 24: Line 24:


Example pages with tables:
Example pages with tables:
* [[Search codes]]
* [[:Category:Table examples]]


=== Wikilinks ===
=== Wikilinks ===
[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Wikipedia_links Wikilinks]<br>
* [http://en.wikipedia.org/wiki/Help:Link#Wikilinks Wikilinks]
{{tl|anchor}} template<br>
* {{tl|anchor}} template<br>
{{tl|ReturnTop}} template<br>
* {{tl|ReturnTop}} template<br>


=== External links ===
=== External links ===
[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Citing_sources External links]
* [http://en.wikipedia.org/wiki/Help:Link#External_links External links]
 
=== Columns ===
 
Example pages with columns:
* Alpha index template [[Massachusetts/Cities and towns]]
* Std columns [[Michigan]]


=== Talk pages ===
=== Talk pages ===
[http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Talk_pages Talk pages]


=== HTML Colors ===
==== New topics ====
[http://www.htmlgoodies.com/tutorials/colors/ Color Tutorials]
When adding a new topic, add a section heading to the talk page with:
<pre>== Heading name of your comment ==</pre>
 
==== Sign your post ====
Sign your posts by adding four ~ in a row:
<pre>~~~~</pre>
 
After saving, the four ~ will automatically be translated into links to your user page and talk page with the date and time of your post. Optionally set off your signature with italics using two ' marks around the four ~.
: This is my comment. ''[[User:Kentsmith9|kentsmith9]] ([[User talk:Kentsmith9|talk]]) 15:49, 16 May 2014 (UTC)''
 
==== Indent responses ====
Use '''indenting''' to show responses to prior entries with the : character using one for each level of indenting desired.
<pre>Initial message.
: Response to initial message.
:: Counter response.
::: Counter to the counter.</pre>
will produce:
 
Initial message.
: Response to initial message.
:: Counter response.
::: Counter to the counter.
 
 
''For additional details see [http://en.wikipedia.org/wiki/Wikipedia:Tutorial/Talk_pages Talk pages]''
 
=== HTML colors ===
* [http://www.htmlgoodies.com/tutorials/colors/ Color Tutorials]
 
=== Template formatting ===
Good templates start with good documentation for the editor. The following template(s) show good formatting for the content that should be documented in the template.
 
* [[Template:Construction]]


== Guidelines ==
== Guidelines ==
Line 55: Line 92:
* Citations should not be placed within or on the same line as section and subsection headings.
* Citations should not be placed within or on the same line as section and subsection headings.
* Headings should not contain images, including flag icons.
* Headings should not contain images, including flag icons.
* Headings should not contain bold character enhancements; in some levels it is already bolded and additional bolding is overkill in the font width. Also, the numeric entry is not going to have bold enhancement and that will make an inconsistent look. [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Text_formatting#Automatically_applied_boldface Wikipedia reference link.]
* Headings should not contain questions.
* Headings should not contain questions.
* Avoid starting headings with numbers (other than years), because this can be confusing for readers with the "Auto-number headings" preference selected.
* Avoid starting headings with numbers (other than years), because this can be confusing for readers with the "Auto-number headings" preference selected.
* Before changing a section heading, consider whether you might be breaking existing links to that section. If there are many links to the old section title, create an {{tl|anchor}} with that title to ensure that the links still work. Similarly, when linking to a section of an article, leave an invisible comment at that section, specifying the names of the linking articles so that if the title is altered, others can fix the links.
* Before changing a section heading, consider whether you might be breaking existing links to that section. If there are many links to the old section title, create an {{tl|anchor}} with that title to ensure that the links still work. Similarly, when linking to a section of an article, leave an invisible comment at that section, specifying the names of the linking articles so that if the title is altered, others can fix the links.
* Do not start headings with a single equal (=) because inside of the Wiki a single equal is used for the title. Always start with two equal signs (==).
* Place Anchors immediately below the section header or at the start of the header text inside the "=".
* Place Anchors immediately below the section header or at the start of the header text inside the "=".


Line 64: Line 103:


=== Renaming pages ===
=== Renaming pages ===
When it becomes necessary to rename a page, the Move tab at the top of a Wiki page should be used for a few reasons. A redirect page is provided automatically from the old name. The edit history is transferred from the original page to the new one. This is important in understanding who introduced changes and when they were made to a page
When it becomes necessary to rename a page, the Move tab at the top of a Wiki page should be used for a few reasons. A redirect page is provided automatically from the old name. The edit history is transferred from the original page to the new one. This is important in understanding who introduced changes and when they were made to a page.
 
If the destination page of the rename already exists, it must be moved to another page without creating a redirect. Otherwise it will require an admin to delete the page.
 
=== Disambiguation pages ===
We follow the [[Wikipedia:Wikipedia:Disambiguation|Wikipedia guidelines for Disambiguation (DAB) pages]]. Primarily make each entry only a single line. Do not use ending punctuation. Only use enough words to differentiate the the linked terms. Only have a single hyperlink per line. Some examples can be seen under the [https://wazeopedia.waze.com/wiki/USA/Category:Disambiguation Category:Disambiguation].
 
=== Punctuation spacing ===
The Wiki was set up with single spacing after the punctuation. In order to keep consistency in the Wiki, do not use double spacing after the punctuation.
 
=== HTTPS ===
When adding an external link, do include the "s" in '''https''' as required by the website. Note that external links with the "s" will not currently display a [https://www.google.com closed lock] image, nor will the [http://www.google.com unsecured external link] type. The only currently supported link or file type that displays in our CSS is the [http://www.google.com/test.pdf PDF document type].
 
=== Measurement units ===
When adding measurements to a page, the units of measure should be formatted with the imperial units first, followed by the metric equivalent in parenthesis.<br />
:{{nowrapcode|The distance is 14 feet (4.3 meters).}}
 
If the actual amount is based on a whole metric unit, then display the fractional portion for the imperial units to at least one decimal place. Avoid 2 or more decimal places unless there is a specific reason to do so that cannot be resolved with the next condition.<br />
:{{nowrapcode|The distance is 16.4 feet (5 meters).}}
 
If the actual amount is based on a whole unit for either measurement system AND it represents a minimum or maximum threashold, then display the whole decimal amount that ensures it is above the minimum or below the maximum threashold as required.<br />
:{{nowrapcode|The minimum distance is 17 feet (5 meters).}}{{clear}}
or<br />
:{{nowrapcode|The minimum distance is 16.5 feet (5 meters).}}<br />
(When the actual limit is 5 meters (resulting in 16.4042 feet.)
 
 
 
== Other questions ==
Please come to the [http://www.waze.com/forum/viewforum.php?f=276 Wiki Editing forum] for any questions not covered above.
 
== See also ==


* [[Waze etiquette]]
[[Category:Wiki Help]]
[[Category:Wiki Help]]

Latest revision as of 23:06, 21 August 2022

This article is not part of the Waze application, but rather a part of the Wiki editing guide. If you reached this page in error, please return to the main page and start your search again. If you have suggestions for changes to this page, please visit this Wiki forum.


Editing

To start this page, content will be linked from other sources until such time that the content can be created directly for the Waze Wiki. Many links will be provided from Wikipedia to expedite the help pages. If a topic is not found in the Waze Wiki, consider checking for a similar topic in the Wikipedia Help Directory.

Editing pages

Text formatting

Image formatting

Table formatting

Example pages with tables:

Wikilinks

External links

Columns

Example pages with columns:

Talk pages

New topics

When adding a new topic, add a section heading to the talk page with:

== Heading name of your comment ==

Sign your post

Sign your posts by adding four ~ in a row:

~~~~

After saving, the four ~ will automatically be translated into links to your user page and talk page with the date and time of your post. Optionally set off your signature with italics using two ' marks around the four ~.

This is my comment. kentsmith9 (talk) 15:49, 16 May 2014 (UTC)

Indent responses

Use indenting to show responses to prior entries with the : character using one for each level of indenting desired.

Initial message.
: Response to initial message.
:: Counter response.
::: Counter to the counter.

will produce:

Initial message.

Response to initial message.
Counter response.
Counter to the counter.


For additional details see Talk pages

HTML colors

Template formatting

Good templates start with good documentation for the editor. The following template(s) show good formatting for the content that should be documented in the template.

Guidelines

Most of the guidelines for the Wiki content follows the Wikipedia guidelines. If a specific policy or guideline is not presented in the Waze Wiki help system, the Wikipedia guideline will serve the purpose.

Page titles

Page titles
Page title format

Section headings

For more information see Wikipedia Section headings and Wikipedia Help on Sections.

  • Headings should not refer redundantly to the subject of the article, or to higher-level headings, unless doing so is shorter or clearer.
  • Headings should not normally contain links, especially where only part of a heading is linked.
  • Section and subsection headings should be unique within a page; otherwise section links may lead to the wrong place, and automatic edit summaries can be ambiguous.
  • Citations should not be placed within or on the same line as section and subsection headings.
  • Headings should not contain images, including flag icons.
  • Headings should not contain bold character enhancements; in some levels it is already bolded and additional bolding is overkill in the font width. Also, the numeric entry is not going to have bold enhancement and that will make an inconsistent look. Wikipedia reference link.
  • Headings should not contain questions.
  • Avoid starting headings with numbers (other than years), because this can be confusing for readers with the "Auto-number headings" preference selected.
  • Before changing a section heading, consider whether you might be breaking existing links to that section. If there are many links to the old section title, create an {{anchor}} with that title to ensure that the links still work. Similarly, when linking to a section of an article, leave an invisible comment at that section, specifying the names of the linking articles so that if the title is altered, others can fix the links.
  • Do not start headings with a single equal (=) because inside of the Wiki a single equal is used for the title. Always start with two equal signs (==).
  • Place Anchors immediately below the section header or at the start of the header text inside the "=".

Creating pages

If you want to build a page without input from others, start by creating it within your user namespace as a subpage of your own. That way you can more directly control the content.

Renaming pages

When it becomes necessary to rename a page, the Move tab at the top of a Wiki page should be used for a few reasons. A redirect page is provided automatically from the old name. The edit history is transferred from the original page to the new one. This is important in understanding who introduced changes and when they were made to a page.

If the destination page of the rename already exists, it must be moved to another page without creating a redirect. Otherwise it will require an admin to delete the page.

Disambiguation pages

We follow the Wikipedia guidelines for Disambiguation (DAB) pages. Primarily make each entry only a single line. Do not use ending punctuation. Only use enough words to differentiate the the linked terms. Only have a single hyperlink per line. Some examples can be seen under the Category:Disambiguation.

Punctuation spacing

The Wiki was set up with single spacing after the punctuation. In order to keep consistency in the Wiki, do not use double spacing after the punctuation.

HTTPS

When adding an external link, do include the "s" in https as required by the website. Note that external links with the "s" will not currently display a closed lock image, nor will the unsecured external link type. The only currently supported link or file type that displays in our CSS is the PDF document type.

Measurement units

When adding measurements to a page, the units of measure should be formatted with the imperial units first, followed by the metric equivalent in parenthesis.

The distance is 14 feet (4.3 meters).

If the actual amount is based on a whole metric unit, then display the fractional portion for the imperial units to at least one decimal place. Avoid 2 or more decimal places unless there is a specific reason to do so that cannot be resolved with the next condition.

The distance is 16.4 feet (5 meters).

If the actual amount is based on a whole unit for either measurement system AND it represents a minimum or maximum threashold, then display the whole decimal amount that ensures it is above the minimum or below the maximum threashold as required.

The minimum distance is 17 feet (5 meters).

or

The minimum distance is 16.5 feet (5 meters).

(When the actual limit is 5 meters (resulting in 16.4042 feet.)


Other questions

Please come to the Wiki Editing forum for any questions not covered above.