VNDev Wiki:Getting Started: Difference between revisions

From VNDev Wiki
Starting revamp. Saving progress
Ok, this is an alright first draft of the reboot.
Line 1: Line 1:
== 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.
== Wiki Layout & Components ==
== Wiki Layout & Components ==
<!-- How the wiki works, guides, talk pages, etc -->
<!-- How the wiki works, guides, talk pages, etc -->


== Editing Basics ==
== Editing Basics ==
Line 12: Line 21:


=== 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:  
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>[[Editing]]</nowiki></blockquote>
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>[[Editing]]</nowiki></blockquote>
Line 21: Line 31:


=== Formatting ===
=== Formatting ===
{{main|mw:Help:Formatting}}
====Italics====
====Italics====
''Put two apostrophes on each side.''
''Put two apostrophes on each side.''
Line 27: Line 38:
'''Put three apostrophes on each side.'''
'''Put three apostrophes on each side.'''
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>''' this is in bold '''</nowiki></blockquote>
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>''' this is in bold '''</nowiki></blockquote>
====Bulleted list====  
====Lists====
*Place an asterisk at the start of each new bullet.  
{{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.
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>* Level 1</nowiki><br /><nowiki>
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki>* Level 1</nowiki><br /><nowiki>
Line 36: Line 49:
* Another Level 1</nowiki></blockquote>
* Another Level 1</nowiki></blockquote>


====Numbered list====
#Numbered lists are mostly the same as above.
#Mostly the same as above
#Use # instead of *.
#Use # instead of *.
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki># Level 1</nowiki><br /><nowiki>
<blockquote style="background:#f2f2f2; width:fit-content"><nowiki># Level 1</nowiki><br /><nowiki>
Line 44: Line 56:
### Another level deep</nowiki><br /><nowiki>
### Another level deep</nowiki><br /><nowiki>
# Another Level 1</nowiki></blockquote>
# Another Level 1</nowiki></blockquote>
<br /><br />[[mw:Cheatsheet|{{clickable button|Cheatsheet|width=200px}}]] [[mw:Help:Formatting|{{clickable button|More formatting tips|width=200px}}]]
== Documentation Links ==
<div style="font-size: 1.8em; font-weight: 501;">Policies and Guidelines</div>
[[VNDev Wiki:Contribution Policy|{{clickable button|Contribution Policy|color=blue|width=200px}}]]
[[VNDev Wiki:Manual of Style|{{clickable button|Manual of Style|width=200px}}]]
<div style="font-size: 1.8em; font-weight: 501;">Basic Editing</div>
[[mw:Help:Formatting|{{clickable button|Formatting|width=200px}}]]
[[mw:Help:Links|{{clickable button|Links|width=200px}}]]
[[mw:Help:Lists|{{clickable button|Lists|width=200px}}]]
[[mw:Help:Tables|{{clickable button|Tables|width=200px}}]]
[[mw:Help:Managing files|{{clickable button|Uploading Files|width=200px}}]]
[[mw:Help:Images|{{clickable button|Images|width=200px}}]]
[[mw:Help:Templates|{{clickable button|Templates|width=200px}}]]
<div style="font-size: 1.8em; font-weight: 501;">Tasks</div>
[[VNDev Wiki:Article Wishlist|{{clickable button|Article Wishlist|width=200px}}]]


[[VNDev Wiki:Wiki Maintenance|{{clickable button|Wiki Maintenance|width=200px}}]]
===Helpful links===
[[mw:Cheatsheet|{{clickable button|Cheatsheet|color=blue|width=200px}}]] [[mw:Help:Formatting|{{clickable button|More formatting tips|color=blue|width=200px}}]] <br /><br />
[[mw:Help:Tables|{{clickable button|Tables|width=200px}}]] [[mw:Help:Managing files|{{clickable button|Uploading Files|width=200px}}]] [[mw:Help:Images|{{clickable button|Images|width=200px}}]] [[mw:Help:Templates|{{clickable button|Templates|width=200px}}]]


== Editing Resources ==
== Editing Resources ==

Revision as of 17:16, 25 November 2024

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.

Wiki Layout & Components

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.

'' this is in italics ''

Bold

Put three apostrophes on each side.

''' this is in bold '''

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.

* Level 1
** This is a sub-bullet
** This is a sub-bullet
*** Another level deep
* Another Level 1

  1. Numbered lists are mostly the same as above.
  2. Use # instead of *.

# Level 1
## This is a sub-bullet
## This is a sub-bullet
### Another level deep
# Another Level 1

Helpful links

Cheatsheet More formatting tips

Tables Uploading Files Images Templates

Editing Resources

Article Management

Community

More information