From 6f16fef07dd1e964a999d943719dfa07d61351a5 Mon Sep 17 00:00:00 2001 From: Yorhel Date: Fri, 6 Nov 2009 00:25:45 +0100 Subject: d11: Formatted the object members and filters as a table I'd hate to have to maintain that HTML code, but at least those tables look nicer in the browser. --- data/docs/11 | 193 +++++++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 135 insertions(+), 58 deletions(-) diff --git a/data/docs/11 b/data/docs/11 index 84a9f97f..5a222372 100644 --- a/data/docs/11 +++ b/data/docs/11 @@ -216,66 +216,143 @@ however still required.
differently and that the order of the members may not be the same. What each member means and what possible values they can have differs per type and is documented below. -

- - +


-:SUB:get vn -Returned object members: -

(the respective info flag is indicated within the parentheses)

-
-
id (always present)
- integer, visual novel ID. -
title (basic)
- string, main title. -
original (basic)
- string, original/official title. Can be null when not known/available. -
released (basic)
- string, date of the first release. Can be null. -
languages (basic)
- array of strings. Can be an empty array when nothing has been released yet. -
platforms (basic)
- array of strings. Can be an empty array when unknown or nothing has been released yet. -
aliases (details)
- string, comma-separated list of aliases. Can be null. -
length (details)
- integer between 1 and 5, length of the game. null when unknown. -
description (details)
- string, description of the VN. Note that this description can include formatting codes as described in d9.3. - null when whe don't have a description. -
links (details)
- object. Contains the following members:
- "wikipedia", string, name of the related article on the English Wikipedia.
- "encubed", string, the URL-encoded tag used on encubed.
- "renai", string, the name part of the url on renai.us.
- All members can be null when no links are available or known to us. -
-
-
+Returned object members for the 'vn' type: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MemberFlagTypenullDescription
id-integernoVisual novel ID
titlebasicstringnoMain title
originalbasicstringyesOriginal/official title.
releasedbasicdate (string)yesDate of the first release.
languagesbasicarray of stringsnoCan be an empty array when nothing has been released yet.
platformsbasicarray of stringsnoCan be an empty array when unknown or nothing has been released yet.
aliasesdetailsstringyesComma-separated list of aliases.
lengthdetailsintegeryesLength of the game, 1-5
descriptiondetailsstringyesDescription of the VN. Can include formatting codes as described in d9.3.
linksdetailsobjectno + Contains the following members:
+ "wikipedia", string, name of the related article on the English Wikipedia.
+ "encubed", string, the URL-encoded tag used on encubed.
+ "renai", string, the name part of the url on renai.us.
+ All members can be null when no links are available or known to us. +
-Filters: -
-
id
- value: integer, operators: =, !=, >, >=, < and <=
- value: array of integers, operators: = and != -
title
- value: string, operators: =, != and ~ -
original
- value: null, operators: = and !=
- value: string, operators: =, != and ~ -
platforms
- values: null, string or array of strings, operators: = and !=
- TODO: document platform codes. -
languages
- values: null, string or array of strings, operators: = and !=
- TODO: document language codes. -
search
- value: string, operator: ~
- This isn't an actual field, but performs a search on the titles of the visual - novel and its releases. Note that the algorithm of this search may change and - that it can use a different algorithm than the search function on the website. -
-
+Accepted filters for the 'vn' type: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldValueOperators 
idinteger
array of integers		= != > >= < <=
= !=		 
titlestring= != ~ 
originalnull
string		= !=
= != ~		 
platformsnull
string
array of strings
= !=		 
languagesnull
string
array of strings
= !=		 
searchstring~ + This is not an actual field, but performs a search on the titles of the visual + novel and its releases. Note that the algorithm of this search may change and + that it can use a different algorithm than the search function on the website. +
-- cgit v1.2.3