title | ID | Topic | CreatedAt | LastUpdated | Authors | Status | Type | Scope | |
---|---|---|---|---|---|---|---|---|---|
TNCPAS-0001 - Metadata Format for Card Edition Forum Post |
TNCPAS-0001 |
Metadata Format for Card Edition Forum Post |
2022-08-27 10:03:20 UTC |
2022-08-27 11:52:30 UTC |
|
Final |
Standard |
BBCode |
TNCPAS-0001
describes a format for machine to read metadata regarding
current card[1] edition release on MyAnimeList forum post.
As The Newbie Club creates several OSS projects such as generating a forum thread for card edition release and read forum posts, a standard is required to avoid any unwanted incompability across the projects.
The metadata format is expected to be implemented in various MyAnimeList clubs for ease card requests parsing/scraping.
-
A metadata for a card edition release format should be started and ended by writing
###
(hashed) block at the first and last line of metadata. The metadata should be named asSCRAPEDATA
orMETADATA
after first hashed block.Note | Please to use
METADATA
ratherSCRAPEDATA
.SCRAPEDATA
is legacy and will not be supported in future.Example:
###METADATA {- content -} ###
-
Metadata content is stated by using the following format:
>>>KEY>>Value
Whereas
KEY
is case sensitive 3-characters name/key that is predefined in ## Metadata Keys, andValue
is case insensitive data value.User can create their own custom key as long the key is 3 characters long
-
When a key is an array, semicolon (
;
) is used as data separator in between. Semicolon is not needed at the end of array data.>>>ARR>>Val;Val;Val;Val{- ;[...] -}
Total amount of values in an array is defined by user.
-
When a data has separate values, use vertical bar (
|
). This method only applicable forLIM
key.>>>LIM>>1|2;4;2;4|5{- ;[...] -}
By default, left value on
LIM
is a limit for member, and right for club staff. -
If a value is empty/null, use
0
. -
If a metadata requires a comment, use
{- ... -}
block>>>KEY>>Value {- This is a comment -}
###METADATA
>>>THM>>Genderbend
>>>STF>>Iris;0;0;0;0
>>>MAX>>100
>>>LIM>>3|6;0;0;0;0
>>>AVA>>6;0;0;0;0
###
{- Generated with GitHub:theNewbieClub-MAL/[email protected] in Powershell on 2022-08-22T04:54:46Z -}
Data Type | Definition |
---|---|
Arr(x) |
Array of x |
Bol |
Boolean (True , False ) |
Int |
Integer/numeral |
Sin |
String OR Integer |
Str |
String |
Key | Stand As | Data Type | Required | Description |
---|---|---|---|---|
AVA |
Available | Arr(Int) |
Yes | Total cards designed by Contributors/Staff in a release |
CLR |
Color | Arr(Str) |
No | Font colors used on a thread in Hex format (#ffffff ) |
LIM |
Limit | Arr(Int) |
Yes | Maximum cards allowed to request each staff per member/staff |
MAX |
Maximum | Int |
No | Maximum requests to accept in one release |
SID |
Staff ID | Arr(Sin) |
No | Card Contributors/Staff ID, see TNCPAS-0002 |
SLP |
Slip | Arr(Boo) |
No | State if Contributor/Staff allows slip card usage |
STF |
Staff | Arr(Str) |
Yes | Card Contributors/Staff Name |
TEM |
Theme Emoji | Str |
No | Edition emoji (for visual identifier in forum title) |
THM |
Theme | Str |
Yes | Edition title/theme |
TID |
Theme ID | Sin |
No | Edition ID, see TNCPAS-0002 |
Metadata uses haskell
syntax highlight.