VNDev Wiki:Getting Started: Difference between revisions
Starting revamp. Saving progress |
m Protected "VNDev Wiki:Getting Started": High traffic page ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading] |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== | {{Shortcut|S:GS}} | ||
Welcome to [[VNDev Wiki]], and thanks for your interest in contributing! This page will fill you in on everything you need to know to start editing. | |||
== What can/should I edit? == | |||
The VNDev Wiki is currently getting its feet on the ground! That means there are many unwritten articles, and many articles that need some serious expansion. Our [[VNDev_Wiki:Article Wishlist|Article Wishlist]] is a great place to start! You can also visit the [[:Category:Article_maintenance|Article Maintenance category]] to find articles that have been flagged as needing some help. | |||
Before you edit, make sure you're familiar with the [[VNDev_Wiki:Manual of Style|Manual of Style]]. Users who fail to follow the [[VNDev_Wiki:Contribution Policy|Contribution Policy]] may have their accounts removed. | |||
== Basics for Programmers == | |||
The VNDev Wiki runs off of [[mw:MediaWiki|MediaWiki]], which in turn uses a combination of Markdown, HTML, and CSS as its basis. All default MediaWiki formatting techniques apply. However, please be aware that many implementations of MediaWiki utilize [[mw:Manual:Extensions|extensions]]. While wiki admins will consider adding extensions, we want to keep them to a minimum to ensure compatibility, ease of use, etc. Feel free to stop by the #vndev-wiki channel in the [https://discord.gg/devtalk DevTalk Discord] to discuss your ideas and use cases. | |||
== Articles vs Guides == | |||
There are two main types of pages on the wiki: Articles and Guides. Articles are encyclopedic in nature, while Guides are formatted like tutorials and explicitly teach the reader how to do something specific. See the [[VNDev_Wiki:Manual_of_Style#Articles vs Guides|Manual of Style]] for more. | |||
== Editing Basics == | == Editing Basics == | ||
| Line 6: | Line 17: | ||
=== Headers === | === Headers === | ||
Headers are set up with equals signs on either side. The more equals signs, the smaller the header. | Headers are set up with equals signs on either side. The more equals signs, the smaller the header. | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>== This is a top level header == | ||
=== One level smaller === | === One level smaller === | ||
==== Even smaller ==== | ==== Even smaller ==== | ||
===== And so on =====</nowiki></ | ===== And so on =====</nowiki></pre> | ||
=== Links === | === Links === | ||
{{main|mw:Help:Links}} | |||
To link to another page on the Wiki, put the name of the page in square brackets: | To link to another page on the Wiki, put the name of the page in square brackets: | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>[[Editing]]</nowiki></pre> | ||
You can also choose the display text for the link. For example, if you want to have the words "beep boop" that link to the Programming page, you can do: | You can also choose the display text for the link. For example, if you want to have the words "beep boop" that link to the Programming page, you can do: | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>[[Programming | beep boop]]</nowiki></pre> | ||
For links external to the Wiki (such as Wikipedia, Itch, VNDB, etc.), use a single set of brackets, and no vertical line divider. | For links external to the Wiki (such as Wikipedia, Itch, VNDB, etc.), use a single set of brackets, and no vertical line divider. | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>[https://google.com Visit Google]</nowiki></pre> | ||
=== Formatting === | === Formatting === | ||
{{main|mw:Help:Formatting}} | |||
====Italics==== | ====Italics==== | ||
''Put two apostrophes on each side.'' | ''Put two apostrophes on each side.'' | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>'' Put two apostrophes on each side. ''</nowiki></pre> | ||
====Bold==== | ====Bold==== | ||
'''Put three apostrophes on each side.''' | '''Put three apostrophes on each side.''' | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>''' Put three apostrophes on each side. '''</nowiki></pre> | ||
==== | ====Lists==== | ||
* | {{main|mw:Help:Lists}} | ||
*For a bulleted list, place an asterisk at the start of each new bullet. | |||
**More asterisks give deeper levels. | **More asterisks give deeper levels. | ||
< | <pre style="background:#f2f2f2; width:fit-content"><nowiki>* Top level | ||
** This is a sub-bullet | ** This is a sub-bullet | ||
** This is a sub-bullet | ** This is a sub-bullet | ||
*** Another level deep | *** Another level deep | ||
* Another | * Another top level</nowiki></pre> | ||
<ol style="margin-left: 1.5em"><li>Numbered lists are mostly the same as above.</li> | |||
< | <li>#Use # instead of *.</li></ol> | ||
<pre style="background:#f2f2f2; width:fit-content"><nowiki># Top level | |||
## This is a sub-bullet | |||
## This is a sub-bullet | |||
### Another level deep | |||
# Another top level</nowiki></pre> | |||
[[ | ===Helpful links=== | ||
[[mw:Cheatsheet|{{clickable button|Cheatsheet|color=blue|width=200px}}]] [[mw:Help:Formatting|{{clickable button|More formatting tips|color=blue|width=200px}}]] [[mw:Help:Tables|{{clickable button|Tables|width=200px}}]] [[mw:Help:Templates|{{clickable button|Templates|width=200px}}]] | |||
== Images == | |||
[[ | Images can be inserted in most locations on the wiki. The syntax is: | ||
<code><nowiki>[[File:NAME.png]]</nowiki></code> | |||
where NAME is replaced by the file name, and ".png" is replaced with the file extension (most often .jpg or .gif) as appropriate. | |||
[[ | By default, images will be displayed at their full size, or the maximum allowed by the page dimensions. Therefore, in most cases, you should specify a size: | ||
<code><nowiki>[[File:NAME.png|200px]]</nowiki></code> | |||
The above example will display File:NAME.png with a width of 200 pixels. The height can be specified instead, if desired. The following example will display the image with a ''height'' of 200 pixels. | |||
<code><nowiki>[[File:NAME.png|x200px]]</nowiki></code> | |||
[[ | In most cases, you should specify "alt text" for images. Alt text helps describe an image for those who cannot see it, whether due to a disability, poor internet quality, or other reasons. Use the following syntax: | ||
<code><nowiki>[[File:NAME.png|100px|alt="An NVL textbox. It covers most of the screen and has a semi-transparent background. A CG is visible behind & around it."]]</nowiki></code> | |||
[[ | If inserting an image in an [[VNDev_Wiki:Manual_of_Style#Infoboxes|Infobox]], set the width to 200 pixels. | ||
[[mw:Help: | [[mw:Help:Images|{{clickable button|More on images|width=250px}}]] | ||
=== Uploading === | |||
To upload an image or other file, click on the "Upload file" link in the left sidebar of any page. Then, select a file from your computer. | |||
In the Summary field, describe the ''context'' of the image for those who may not know what it is. This is not the same as alt text, and does not need to describe the ''content'' of the image. Rather, Summary is a place to note what the file is and why it may be used on the wiki. | |||
Ensure that you select the appropriate usage license from the drop-down menu. | |||
[[ | [[mw:Help:Managing files|{{clickable button|More on uploading files|width=250px}}]] | ||
== Editing Resources == | == Editing Resources == | ||
| Line 88: | Line 104: | ||
[[Category:VNDev Wiki]] | [[Category:VNDev Wiki]] | ||
__NOEDITSECTION__ | |||
Latest revision as of 07:53, 20 February 2025
Welcome to VNDev Wiki, and thanks for your interest in contributing! This page will fill you in on everything you need to know to start editing.
What can/should I edit?
The VNDev Wiki is currently getting its feet on the ground! That means there are many unwritten articles, and many articles that need some serious expansion. Our Article Wishlist is a great place to start! You can also visit the Article Maintenance category to find articles that have been flagged as needing some help.
Before you edit, make sure you're familiar with the Manual of Style. Users who fail to follow the Contribution Policy may have their accounts removed.
Basics for Programmers
The VNDev Wiki runs off of MediaWiki, which in turn uses a combination of Markdown, HTML, and CSS as its basis. All default MediaWiki formatting techniques apply. However, please be aware that many implementations of MediaWiki utilize extensions. While wiki admins will consider adding extensions, we want to keep them to a minimum to ensure compatibility, ease of use, etc. Feel free to stop by the #vndev-wiki channel in the DevTalk Discord to discuss your ideas and use cases.
Articles vs Guides
There are two main types of pages on the wiki: Articles and Guides. Articles are encyclopedic in nature, while Guides are formatted like tutorials and explicitly teach the reader how to do something specific. See the Manual of Style for more.
Editing Basics
To edit a page, log in, then click "Edit" in the top right. You can then enter text normally, with no special formatting required.
Headers
Headers are set up with equals signs on either side. The more equals signs, the smaller the header.
== This is a top level header == === One level smaller === ==== Even smaller ==== ===== And so on =====
Links
- Main article: mw:Help:Links
To link to another page on the Wiki, put the name of the page in square brackets:
[[Editing]]
You can also choose the display text for the link. For example, if you want to have the words "beep boop" that link to the Programming page, you can do:
[[Programming | beep boop]]
For links external to the Wiki (such as Wikipedia, Itch, VNDB, etc.), use a single set of brackets, and no vertical line divider.
[https://google.com Visit Google]
Formatting
- Main article: mw:Help:Formatting
Italics
Put two apostrophes on each side.
'' Put two apostrophes on each side. ''
Bold
Put three apostrophes on each side.
''' Put three apostrophes on each side. '''
Lists
- Main article: mw:Help:Lists
- For a bulleted list, place an asterisk at the start of each new bullet.
- More asterisks give deeper levels.
* Top level ** This is a sub-bullet ** This is a sub-bullet *** Another level deep * Another top level
- Numbered lists are mostly the same as above.
- #Use # instead of *.
# Top level ## This is a sub-bullet ## This is a sub-bullet ### Another level deep # Another top level
Helpful links
Images
Images can be inserted in most locations on the wiki. The syntax is:
[[File:NAME.png]]
where NAME is replaced by the file name, and ".png" is replaced with the file extension (most often .jpg or .gif) as appropriate.
By default, images will be displayed at their full size, or the maximum allowed by the page dimensions. Therefore, in most cases, you should specify a size:
[[File:NAME.png|200px]]
The above example will display File:NAME.png with a width of 200 pixels. The height can be specified instead, if desired. The following example will display the image with a height of 200 pixels.
[[File:NAME.png|x200px]]
In most cases, you should specify "alt text" for images. Alt text helps describe an image for those who cannot see it, whether due to a disability, poor internet quality, or other reasons. Use the following syntax:
[[File:NAME.png|100px|alt="An NVL textbox. It covers most of the screen and has a semi-transparent background. A CG is visible behind & around it."]]
If inserting an image in an Infobox, set the width to 200 pixels.
Uploading
To upload an image or other file, click on the "Upload file" link in the left sidebar of any page. Then, select a file from your computer.
In the Summary field, describe the context of the image for those who may not know what it is. This is not the same as alt text, and does not need to describe the content of the image. Rather, Summary is a place to note what the file is and why it may be used on the wiki.
Ensure that you select the appropriate usage license from the drop-down menu.
