mirror of
https://github.com/JockeTF/fimfarchive.git
synced 2024-11-22 13:28:00 +01:00
Update story meta example in readme
This commit is contained in:
Joakim Soderlund
parent
f7f6f43886
commit
d62b1dda80
1 changed files with 100 additions and 48 deletions
140
docs/readme.tex
140
docs/readme.tex
|
|
@ -30,59 +30,111 @@ Note that the archive contains a large number of files. Unzipping it to your fil
|
||||||
|
|
||||||
\section{Index} \label{sec:index}
|
\section{Index} \label{sec:index}
|
||||||
|
|
||||||
The metadata of each story can be found in \path{index.json}. The file contains one story entry per line ordered by story ID. It was constructed using data from the Fimfiction API, which is incomplete. Additionally, each entry includes the attribute \emph{path} which shows where in the archive the story is located. Below is an example entry for the story \emph{Sunny Skies All Day Long}. Note that the structure of the metadata may change in the future as it depends on Fimfiction.
|
The metadata of each story can be found in \path{index.json}. The file contains one story entry per line ordered by story ID. It was constructed using data from the Fimfiction API, which is incomplete. Additionally, each entry includes the attribute \path{archive.path} which shows where in the archive the story is located. Below is an example entry for the story \emph{Sunny Skies All Day Long}. Note that the structure of the metadata may change in the future.
|
||||||
|
|
||||||
\begin{lstlisting}[breaklines, basicstyle=\ttfamily\small, columns=flexible]
|
\begin{lstlisting}[breaklines, basicstyle=\ttfamily\small, columns=flexible]
|
||||||
{
|
{
|
||||||
"20685":{
|
"archive": {
|
||||||
"author":{
|
"date_checked": "2017-11-03T12:03:47.175215+00:00",
|
||||||
"id":"26190",
|
"date_created": null,
|
||||||
"name":"PhantomFox"
|
"date_fetched": "2017-11-03T12:03:47.175215+00:00",
|
||||||
|
"date_updated": "2017-11-03T12:03:47.175215+00:00",
|
||||||
|
"path":"epub/p/phantomfox-26190/sunny_skies_all_day_long-20685.epub"
|
||||||
},
|
},
|
||||||
"categories":{
|
"author": {
|
||||||
"Adventure":false,
|
"avatar": {
|
||||||
"Alternate Universe":false,
|
"128": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-128",
|
||||||
"Anthro":false,
|
"16": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-16",
|
||||||
"Comedy":false,
|
"192": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-192",
|
||||||
"Crossover":false,
|
"256": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-256",
|
||||||
"Dark":false,
|
"32": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-32",
|
||||||
"Human":false,
|
"384": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-384",
|
||||||
"Random":false,
|
"48": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-48",
|
||||||
"Romance":false,
|
"512": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-512",
|
||||||
"Sad":false,
|
"64": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-64",
|
||||||
"Slice of Life":true,
|
"96": "https://cdn-img.fimfiction.net/user/p8d8-1431820610-26190-96"
|
||||||
"Tragedy":false
|
|
||||||
},
|
},
|
||||||
"chapter_count":1,
|
"bio_html": "",
|
||||||
"chapters":[
|
"date_joined": "2012-04-13T19:09:19+00:00",
|
||||||
|
"id": 26190,
|
||||||
|
"name": "PhantomFox",
|
||||||
|
"num_blog_posts": 1,
|
||||||
|
"num_followers": 699,
|
||||||
|
"num_stories": 3,
|
||||||
|
"url": "https://www.fimfiction.net/user/26190/PhantomFox"
|
||||||
|
},
|
||||||
|
"chapters": [
|
||||||
{
|
{
|
||||||
"date_modified":1348680464,
|
"chapter_number": 1,
|
||||||
"id":63408,
|
"date_modified": "2012-09-26T17:27:44+00:00",
|
||||||
"link":"http://www.fimfiction.net/story/20685/1/sunny-skies-all-day-long/-",
|
"date_published": "2012-09-26T17:27:44+00:00",
|
||||||
"title":"Chapter 1",
|
"id": 63408,
|
||||||
"views":44911,
|
"num_views": 86994,
|
||||||
"words":8536
|
"num_words": 8536,
|
||||||
|
"published": true,
|
||||||
|
"title": "Chapter 1",
|
||||||
|
"url": "https://www.fimfiction.net/story/20685/1/sunny-skies-all-day-long/chapter-1"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"comments":529,
|
"color": {
|
||||||
"content_rating":0,
|
"hex": "dfbeae",
|
||||||
"content_rating_text":"Everyone",
|
"rgb": [
|
||||||
"date_modified":1334414541,
|
223,
|
||||||
"description":"Princess Celestia tires of constantly being surrounded by decorum, deference, and formality, and decides to take a day off from being Princess. But visiting Ponyville incognito is harder than she expects. Will she be able to fit in and make friends without blowing her cover?",
|
190,
|
||||||
"dislikes":81,
|
174
|
||||||
"full_image":"http://www.fimfiction-static.net/images/story_images/20685.png",
|
]
|
||||||
"id":20685,
|
},
|
||||||
"image":"http://www.fimfiction-static.net/images/story_images/20685_r.png",
|
"completion_status": "complete",
|
||||||
"likes":5079,
|
"content_rating": "everyone",
|
||||||
"path":"epub/p/phantomfox-26190/sunny_skies_all_day_long-20685.epub",
|
"cover_image": {
|
||||||
"short_description":"Celestia's Day Off",
|
"full": "https://cdn-img.fimfiction.net/story/5c7h-1432428695-20685-full",
|
||||||
"status":"Complete",
|
"large": "https://cdn-img.fimfiction.net/story/5c7h-1432428695-20685-large",
|
||||||
"title":"Sunny Skies All Day Long",
|
"medium": "https://cdn-img.fimfiction.net/story/5c7h-1432428695-20685-medium",
|
||||||
"total_views":44911,
|
"thumbnail": "https://cdn-img.fimfiction.net/story/5c7h-1432428695-20685-tiny"
|
||||||
"url":"http://www.fimfiction.net/story/20685/sunny-skies-all-day-long",
|
},
|
||||||
"views":44911,
|
"date_modified": null,
|
||||||
"words":8536
|
"date_published": "2012-04-14T14:42:21+00:00",
|
||||||
|
"date_updated": "2012-04-14T14:42:21+00:00",
|
||||||
|
"description_html": "<p>Princess Celestia tires of constantly being surrounded by decorum, deference, and formality, and decides to take a day off from being Princess. But visiting Ponyville incognito is harder than she expects. Will she be able to fit in and make friends without blowing her cover?</p>",
|
||||||
|
"id": 20685,
|
||||||
|
"num_chapters": 1,
|
||||||
|
"num_comments": 773,
|
||||||
|
"num_dislikes": 140,
|
||||||
|
"num_likes": 8796,
|
||||||
|
"num_views": 86994,
|
||||||
|
"num_words": 8536,
|
||||||
|
"prequel": null,
|
||||||
|
"published": true,
|
||||||
|
"rating": 98,
|
||||||
|
"short_description": "Celestia's Day Off",
|
||||||
|
"status": "visible",
|
||||||
|
"submitted": true,
|
||||||
|
"tags": [
|
||||||
|
{
|
||||||
|
"id": 73,
|
||||||
|
"name": "Main 6",
|
||||||
|
"old_id": "c:74",
|
||||||
|
"type": "character",
|
||||||
|
"url": "https://www.fimfiction.net/tag/main-6"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 16,
|
||||||
|
"name": "Princess Celestia",
|
||||||
|
"old_id": "c:17",
|
||||||
|
"type": "character",
|
||||||
|
"url": "https://www.fimfiction.net/tag/princess-celestia"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": 237,
|
||||||
|
"name": "Slice of Life",
|
||||||
|
"old_id": "g:slice_of_life",
|
||||||
|
"type": "genre",
|
||||||
|
"url": "https://www.fimfiction.net/tag/slice-of-life"
|
||||||
}
|
}
|
||||||
|
],
|
||||||
|
"title": "Sunny Skies All Day Long",
|
||||||
|
"total_num_views": 86994,
|
||||||
|
"url": "https://www.fimfiction.net/story/20685/sunny-skies-all-day-long"
|
||||||
}
|
}
|
||||||
\end{lstlisting}
|
\end{lstlisting}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue