Difference between revisions of "Editor's information"

From Valve Cut Content
Jump to: navigation, search
oldwiki>Livelong2
(add mapdocs)
m (Why Not Edit?)
(16 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
<!-- Old EI is a dumpster fire, going for a more wikipedia-inspired approach -->
 
<!-- Old EI is a dumpster fire, going for a more wikipedia-inspired approach -->
==What is the VCC Wiki?==
 
VCC Wiki is a wiki dedicated to the documentation of Valve's Cut Content. It was created in response to a perceived absence of this documentation in the more "generalist" Valve wikis.
 
  
As a result of this, our primary focus is on Valve's cut content, and the community surrounding it.
+
==General==
 +
 
 +
===User Accounts===
 +
If you wish to Contribute to the wiki, you can create an account using the appropriate button. If however user registration is currently closed, this will not work and instead you will need to contact a wiki admin in order to make an account. This can be done on the [https://discord.gg/scXwfXt official discord] on which a steam account is usually required to enter, if a user goes idle prior to entering the discord proper they will be kicked, but if you can contact an admin and say you came from the wiki you can proceed without a steam account.
 +
 
 
===Why Not Edit?===
 
===Why Not Edit?===
 
Notice a factual error somewhere? See a formatting issue that nobody seems to have noticed? Try your hand at editing it!
 
Notice a factual error somewhere? See a formatting issue that nobody seems to have noticed? Try your hand at editing it!
  
Even if you don't do the job correctly, all that will happen is that someone will come over and fix it, perhaps telling you how to do it correctly the next time.
+
If you need help about the syntax used for wiki formatting, you can find the general reference for mediawiki-based wikis [https://www.mediawiki.org/wiki/Help:Contents here].
 +
 
 +
Even if you don't do the job correctly, all that will happen is that someone will come over and fix it, telling you how to do it correctly the next time.
 +
 
 +
Don't be afraid to edit. It is easier to fix, than to have to build the whole thing. If you are unsure about editing an "official" page you can make a note of what you would change in the "Article-ToDo" section at the top of the page.
 +
 
 +
If you're looking for help or feedback, head on over to our official discord and '''@ai_relationship_wiki'''! This way you can talk in real time rather than waiting on the talk page.
  
Don't be afraid to edit. Nobody blames an editor with good intentions.
 
 
===Page Philosophy===
 
===Page Philosophy===
 
Let's face it - we're not going to have a universal set of standards for everything, considering our weird and varied subject matter.
 
Let's face it - we're not going to have a universal set of standards for everything, considering our weird and varied subject matter.
  
 
When doing something new, don't approach it with a bunch of pre-thought-out header structures in mind. Think to yourself, what would work best? Often, that's the way that gets the best results.
 
When doing something new, don't approach it with a bunch of pre-thought-out header structures in mind. Think to yourself, what would work best? Often, that's the way that gets the best results.
 +
 +
as noted earlier, anything you would like to add to a page but aren't sure about its structure, go ahead and add it to the article ToDo and that way it can be figured out before putting it on the actual article. We have jerry rigged our talk pages to act as [[Wiki_Todo| todo pages]] since we primarily use discord for discussion.
 
==Subpages==
 
==Subpages==
 +
===Starter guides===
 +
If you are new, look over these. If not, no need.
 +
*[[Editor's_information/Getting_Started|Getting Started]]
 +
**A starter guide to becoming an editor, explaining creating pages, formatting text, and adding images.
 +
===Should Reads===
 
It's helpful to look over these pages before editing:
 
It's helpful to look over these pages before editing:
 
*[[Editor's_information/Neutral_Point_of_View|Neutral Point of View]]
 
*[[Editor's_information/Neutral_Point_of_View|Neutral Point of View]]
 
**A quick overview of Neutral Point of View, and how to use it.
 
**A quick overview of Neutral Point of View, and how to use it.
 
*[[Editor's_information/Formatting_Conventions|Formatting Conventions]]
 
*[[Editor's_information/Formatting_Conventions|Formatting Conventions]]
**A list of standardized formatting conventions.
+
**A (relatively short) list of formatting conventions. Getting familiar now will save you time later.
*[[Editor's_information/Categorization_Guide|Categorization Guide]]
 
**A list of actively-used tags, and when they should be used.
 
 
*[[Editor's_information/Useful_Stuff|Useful Stuff]]
 
*[[Editor's_information/Useful_Stuff|Useful Stuff]]
 
**An index of files and programs that are extremely useful to have when editing on this wiki.
 
**An index of files and programs that are extremely useful to have when editing on this wiki.
 
*[[Editor's_information/Template_Guide|Template Guide]]
 
*[[Editor's_information/Template_Guide|Template Guide]]
 
**A guide on how to use templates, and a list of the templates VCC Wiki makes usage of.
 
**A guide on how to use templates, and a list of the templates VCC Wiki makes usage of.
*[[Editor%27s_information/Map_Documentation_Guide|Map Documentation Guide]]
+
===Can Reads===
 +
They aren't necessary, but are useful in their own situations.
 +
*[[Editor's_information/Categorization_Guide|Categorization Guide]]
 +
**A list of actively-used tags, and when they should be used.
 +
*[[Editor's_information/Map_Documentation_Guide|Map Documentation Guide]]
 
**A composite guide for map documentation articles.
 
**A composite guide for map documentation articles.
==Page Structures==
+
*[[Editor%27s_information/Page_Structures|Page Structures]]
A list of semi-standardized page structures. They might fit with what you are trying to write.
+
**Various "templates" for page structures.
The bullet point levels are representative of the header levels.
 
===<b>"Evolution" Structure</b>===
 
 
 
<b>Overview:</b>
 
 
 
*Second-level headers are used to divide into "sections" of the particular thing's evolution.
 
**Third-level headers are used after, to show what we have of that particular revision.
 
*Including final versions is optional, but usually beneficial.
 
 
 
<b>Works best with:</b>
 
 
 
Articles with a long and notable history. Otherwise, an early version might fit better as a "notable aspect" header.
 
 
 
<b>Examples:</b>
 
 
 
*[[Combine Soldier (Evolution)]]
 
*[[Metropolice (Evolution)]]
 
 
 
===<b>"Timeline" Structure</b>===
 
<b>Headers:</b>
 
 
 
*Major events (or years) serve as level 1 headers, dividing events.
 
**Individual days where events occur serve as level 2 headers.
 
**Individual events are laid out below the days with bullet points.
 
*At the very end, a header for references is included.
 
 
 
<b>Works best with:</b>
 
 
 
Large, multi-month events, with smaller bits scattered over multiple days.
 
 
 
<b>Examples:</b>
 
 
 
*[[Timeline_of_Leaks_(Facepunch-Era)]]
 
 
 
===<b>"Weapon" Structure</b>===
 
<b>Headers:</b>
 
 
 
*First, a brief description of what the weapon is, with the weapon name in bold. I.E.:
 
<blockquote>
 
The <b>XM29 OICW</b> is the effective predecessor to the OSPIR. It is still in use in the leak, and thus fully present.
 
</blockquote>
 
*Two level two headers:
 
**Overview
 
**Tactics
 
**Further case-by-case headers, documenting notable aspects of the weapon. I.E.:
 
***Older Texture
 
***Cut Grenade Launching Function
 
***Facepunch Leaks
 
*Another level-two header gallery, with dividing subheaders something like this:
 
**Screenshots
 
**Renders
 
**Textures
 
*A header for references. (If used!)
 
 
 
<b>Works best with:</b>
 
 
 
*Articles documenting weapons. The general idea of it can be applied elsewhere, though.
 
 
 
<b>Examples:</b>
 
 
 
*[[AK-47 (AR1)]]
 
*[[Heavy Machine Gun (HMG1)]]
 
*[[MP5K (SMG1)]]
 
*[[XM29 OICW]]
 
 
 
===<b>Map Structure</b>===
 
#Standard pre-desc
 
**Overview
 
**Unused References
 
**Unused Visgroups
 
***overview of each unused visgroup, if applicable
 
**Gallery
 
***In-Game
 
***Hammer
 
 
[[Category:Editor Documents]]
 
[[Category:Editor Documents]]
 +
==Misc==
 +
*[[Importing Images]]
 +
**A guide to re-importing pages to the VCC Wiki.

Revision as of 02:05, 19 December 2020


General

User Accounts

If you wish to Contribute to the wiki, you can create an account using the appropriate button. If however user registration is currently closed, this will not work and instead you will need to contact a wiki admin in order to make an account. This can be done on the official discord on which a steam account is usually required to enter, if a user goes idle prior to entering the discord proper they will be kicked, but if you can contact an admin and say you came from the wiki you can proceed without a steam account.

Why Not Edit?

Notice a factual error somewhere? See a formatting issue that nobody seems to have noticed? Try your hand at editing it!

If you need help about the syntax used for wiki formatting, you can find the general reference for mediawiki-based wikis here.

Even if you don't do the job correctly, all that will happen is that someone will come over and fix it, telling you how to do it correctly the next time.

Don't be afraid to edit. It is easier to fix, than to have to build the whole thing. If you are unsure about editing an "official" page you can make a note of what you would change in the "Article-ToDo" section at the top of the page.

If you're looking for help or feedback, head on over to our official discord and @ai_relationship_wiki! This way you can talk in real time rather than waiting on the talk page.

Page Philosophy

Let's face it - we're not going to have a universal set of standards for everything, considering our weird and varied subject matter.

When doing something new, don't approach it with a bunch of pre-thought-out header structures in mind. Think to yourself, what would work best? Often, that's the way that gets the best results.

as noted earlier, anything you would like to add to a page but aren't sure about its structure, go ahead and add it to the article ToDo and that way it can be figured out before putting it on the actual article. We have jerry rigged our talk pages to act as todo pages since we primarily use discord for discussion.

Subpages

Starter guides

If you are new, look over these. If not, no need.

  • Getting Started
    • A starter guide to becoming an editor, explaining creating pages, formatting text, and adding images.

Should Reads

It's helpful to look over these pages before editing:

  • Neutral Point of View
    • A quick overview of Neutral Point of View, and how to use it.
  • Formatting Conventions
    • A (relatively short) list of formatting conventions. Getting familiar now will save you time later.
  • Useful Stuff
    • An index of files and programs that are extremely useful to have when editing on this wiki.
  • Template Guide
    • A guide on how to use templates, and a list of the templates VCC Wiki makes usage of.

Can Reads

They aren't necessary, but are useful in their own situations.

Misc