summaryrefslogtreecommitdiff
path: root/data
diff options
context:
space:
mode:
authoryorhel <yorhel@1fe2e327-d9db-4752-bcf7-ef0cb4a1748b>2008-06-28 12:35:08 +0000
committeryorhel <yorhel@1fe2e327-d9db-4752-bcf7-ef0cb4a1748b>2008-06-28 12:35:08 +0000
commit7fff82653172c91e6e84b637beab90be56b0c418 (patch)
treebfcf915dc26236526753225794e850651daa85fc /data
parent181e434ac94f5159b00582b97e33356a27a56b1b (diff)
Improved documentation index, and removed the indication of required fields - people will figure out themselves
git-svn-id: svn://vndb.org/vndb@41 1fe2e327-d9db-4752-bcf7-ef0cb4a1748b
Diffstat (limited to 'data')
-rw-r--r--data/docs/28
-rw-r--r--data/docs/320
-rw-r--r--data/docs/410
-rw-r--r--data/docs/56
-rw-r--r--data/docs/61
-rw-r--r--data/docs/index8
-rw-r--r--data/docs/notfinished3
7 files changed, 35 insertions, 21 deletions
diff --git a/data/docs/2 b/data/docs/2
index 35fbc5e2..5986e48c 100644
--- a/data/docs/2
+++ b/data/docs/2
@@ -2,15 +2,15 @@
:INC:notfinished
:INC:index
-:SUB:General guidelines
+:SUB:When to add a visual novel
<p>
- Blahblah about what we define as VN...
+ <i>TODO</i>
</p>
:SUB:General info
<dl>
- <dt>*Title</dt><dd>
+ <dt>Title</dt><dd>
The title of the visual novel as it is known to the English speaking audience. If
there is no English version of the game available, you should either specify the
romanized (recommended) or translated (not recommended) version of the original
@@ -19,7 +19,7 @@
Visual novels can be known under several names, use this field to add any aliases
and acronyms used around the net. Official titles of releases should not be added
here, as these are already listed in the releases.
- </dd><dt>*Description</dt><dd>
+ </dd><dt>Description</dt><dd>
Short description of the main story.
</dd><dt>Length</dt><dd>
Very rough estimate of the time required to finish all endings of the visual novel.
diff --git a/data/docs/3 b/data/docs/3
index 2a0b577a..238e48c2 100644
--- a/data/docs/3
+++ b/data/docs/3
@@ -2,14 +2,22 @@
:INC:notfinished
:INC:index
+
+:SUB:When to add a release
<p>
- <i>When to add a release (stuff about NOT adding fandisks, OSTs, etc)</i>
+ A 'release' is a product - either physical or digital - containing (parts of) the
+ visual novel. This excludes soundtracks, drama CDs, fandisks, and other products
+ that do not contain the visual novel itself.<br />
+ All releases should be added seperately. For example, a limited and a regular edition
+ shouldn't be combined into one release, even if they share the release date and
+ contents. For commercial games, separate releases can be distinguished by their
+ JAN/UPC/EAN number.
</p>
:SUB:General info
<dl>
- <dt>*Type</dt><dd>
+ <dt>Type</dt><dd>
Is the release complete, partial or a trial version?
Complete releases have everything.
Partial releases have most of the game, but there are things still waiting
@@ -17,12 +25,12 @@
Trial versions are heavily cut down and free releases so that you can
experience a game before you buy it. Sometimes, trial versions are cut
down for web transmission and do not completely represent the finished product.
- </dd><dt>*Title (romaji)</dt><dd>
+ </dd><dt>Title (romaji)</dt><dd>
The name of the release, in the Latin character set (using Romanisation or translation)
</dd><dt>Original title</dt><dd>
If the name is officially under a different title (usually because of different
character sets), put the original title here.
- </dd><dt>*Language</dt><dd>
+ </dd><dt>Language</dt><dd>
What language is this release? Use the language that the majority of the game is in.
</dd><dt>JAN/UPC/EAN</dt><dd>
The <a href="http://en.wikipedia.org/wiki/Global_Trade_Item_Number">GTIN</a> code
@@ -30,7 +38,7 @@
and "EAN" for Europe. The system will automatically detect the type from the code and
use the appropriate term on the release page.
</dd><dt>Official website</dt><dd>
- ..
+ URL of the official homepage for this product.
</dd><dt>Release date</dt><dd>
For commercial games, the sale date.
For all others, the date on which the release was first available.
@@ -39,7 +47,7 @@
..
</dd><dt>Notes</dt><dd>
Anything miscellaneous and useful.
- Generally, JAN codes, extras (but not preorder bonuses) and progress information go here.
+ Generally, extras (but not preorder bonuses) and progress information go here.
</dd>
</dl>
diff --git a/data/docs/4 b/data/docs/4
index 7fb0c4c7..71293904 100644
--- a/data/docs/4
+++ b/data/docs/4
@@ -2,20 +2,22 @@
:INC:notfinished
:INC:index
+
+:SUB:When to add a producer
<p>
- <i>When to add a producer and what to do with producer relations...</i>
+ <i>TODO</i>
</p>
:SUB:General info
<dl>
- <dt>*Type</dt><dd>
+ <dt>Type</dt><dd>
The type of producer.
- </dd><dt>*Name (romaji)</dt><dd>
+ </dd><dt>Name (romaji)</dt><dd>
The name of the producer in the Latin alphabet (using Romanisation or translation).
</dd><dt>Original name</dt><dd>
If the Name (above) has been Romanised or translated, place the original name here.
- </dd><dt>*Primary language</dt><dd>
+ </dd><dt>Primary language</dt><dd>
The language the the producer works in most of the time. By default, it is Japanese.
</dd><dt>Website</dt><dd>
Official homepage of the producer.
diff --git a/data/docs/5 b/data/docs/5
index 1d3889b3..cea0817f 100644
--- a/data/docs/5
+++ b/data/docs/5
@@ -29,6 +29,7 @@
Wikipedia</a>) for titles and names before being entered in the database.
</p>
+
:SUB:Name order
<p>
In most English speaking countries, names are given in a "given name, family name"
@@ -43,12 +44,11 @@
a character has a completely foreign name (Mary Smith), use Western order.
</p>
-:SUB:...and more!
+
+:SUB:TODO
<p>
Misc documentation:<br />
- Edit summary<br />
- Quoting sources in descriptions<br />
-- Piracy<br />
-- Spoilers<br />
</p>
diff --git a/data/docs/6 b/data/docs/6
index 5f953d6e..b5d1b80a 100644
--- a/data/docs/6
+++ b/data/docs/6
@@ -1,4 +1,5 @@
:TITLE:Frequently Asked Questions
+:INC:index
:SUB:What is a Visual Novel?
diff --git a/data/docs/index b/data/docs/index
index 8eb7ed6c..5c527c02 100644
--- a/data/docs/index
+++ b/data/docs/index
@@ -1,10 +1,12 @@
<ul class="index">
- <li><b>Documentation index</b></li>
- <li><a href="/d6">FAQ</a></li>
- <li><a href="/d1">Categories</a></li>
+ <li><b>Guidelines</b></li>
<li><a href="/d5">General guidelines</a></li>
+ <li><a href="/d1">Categories</a></li>
<li><a href="/d2">Visual Novels</a></li>
<li><a href="/d3">Releases</a></li>
<li><a href="/d4">Producers</a></li>
+ <li><b>About VNDB</b></li>
+ <li><a href="/d6">FAQ</a></li>
<li><a href="/d7">About us</a></li>
+ <li><a href="/d8">Development</a></li>
</ul>
diff --git a/data/docs/notfinished b/data/docs/notfinished
index dcf0e4b5..192b1c07 100644
--- a/data/docs/notfinished
+++ b/data/docs/notfinished
@@ -1,3 +1,4 @@
<span class="warning">
- This page is not yet finished!
+ This page is not yet finished!<br />
+ If you are interested in helping out, please join us on <a href="irc://irc.synirc.net/vndb">IRC</a>.
</span>