From d387136a61bf93fdc495f2bead2874be3b7733cf Mon Sep 17 00:00:00 2001 From: yorhel Date: Sat, 28 Jun 2008 17:05:35 +0000 Subject: Documentation patch by apple git-svn-id: svn://vndb.org/vndb@43 1fe2e327-d9db-4752-bcf7-ef0cb4a1748b --- data/docs/5 | 38 ++++++++++++++++++++++++++------------ data/docs/8 | 1 + data/docs/notfinished | 2 +- data/tpl/vnedit | 4 ++-- 4 files changed, 30 insertions(+), 15 deletions(-) (limited to 'data') diff --git a/data/docs/5 b/data/docs/5 index cea0817f..1778bd3a 100644 --- a/data/docs/5 +++ b/data/docs/5 @@ -30,25 +30,39 @@

-:SUB:Name order +:SUB:Name Order

- In most English speaking countries, names are given in a "given name, family name" - order. This is called "Western Order". In English, you call someone using their - given name if you know them well, otherwise use their title and family name. - In Japanese (and some other languages too), names are given in "family name, given name" - order. We call this "Japanese Order". In Japanese you can call someone using either - name with an appropriate suffix. To aid English speakers familiar, some resources - (e.g. wikipedia) switch round Japanese names. Here on vndb.org, we prefer to use the - order that the original game used. That is, if it was originally a Japanese game with - Japanese character names, use Japanese order. If the game is originally English, or - a character has a completely foreign name (Mary Smith), use Western order. + In most English speaking countries, names are given in a "given name, family name" order. + This is called "Western Order". + In English, you call someone using their given name if you know them well, otherwise use their title and family name. +
+ In Japanese (and some other languages too), names are given in "family name, given name" order. + We call this "Japanese Order". + In Japanese you can call someone using either name with an appropriate suffix. +
+ To aid English speakers, some resources (e.g. wikipedia) use Japanese names in Western order. + Here on vndb.org, we prefer to use the order that the original game used. +
+ That is, if it was originally a Japanese game with Japanese character names, use Japanese order. +
+ If the game is originally English, or a character has a completely foreign name (Mary Smith), use Western order.

+:SUB:Edit Summaries +

+ Every edit to any page has an optional "Edit summary" box. +
+ This allows you to explain yourself on what your edit is about without cluttering the main page. +
+ You can say why you've modified the categories, changed a link, or show where you obtained some information (so that other contributors can verify it). +
+ Perhaps you want to add a visual novel to the database but are unable to find more information for it. + If you say so here, another contributor is bound to finish it off. +

:SUB:TODO

Misc documentation:
-- Edit summary
- Quoting sources in descriptions

diff --git a/data/docs/8 b/data/docs/8 index cad1262b..ce867124 100644 --- a/data/docs/8 +++ b/data/docs/8 @@ -1,4 +1,5 @@ :TITLE:The VNDB TODO list +:INC:index :SUB:Some notes diff --git a/data/docs/notfinished b/data/docs/notfinished index 192b1c07..8fc2669a 100644 --- a/data/docs/notfinished +++ b/data/docs/notfinished @@ -1,4 +1,4 @@ This page is not yet finished!
- If you are interested in helping out, please join us on IRC. + If you are interested in helping us finish it off, please join us on IRC. diff --git a/data/tpl/vnedit b/data/tpl/vnedit index 66d0e40f..c6cbd3ae 100644 --- a/data/tpl/vnedit +++ b/data/tpl/vnedit @@ -59,7 +59,7 @@ { type => 'sub', title => 'Categories', short => 'cat' }, { type => 'hidden', short => 'categories' }, { type => 'static', raw => 1, text => eval { - my $r = 'Please read the category descriptions before adding or modifying categories!

' + my $r = 'Please read the category descriptions before modifying categories!

' .'