zinricky/gempub
1
0
Fork 0
mirror of https://codeberg.org/oppenlab/gempub.git synced 2024-06-24 02:27:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
ÖLAB 2021-04-26 22:36:42 +02:00
parent ac30d20ca5
commit e9daad07e8
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -57,11 +57,11 @@ The metadata.txt file contains key value pairs separated by line, values start a
* gpubVersion - mandatory Gempub format version: 1.0.0
* index - path to start index.gmi
* author
* language - ISO 639-1 or ISO 639-2: eg. en or eng **NOTE: rethinking this item, will update after research... - the idea is to be able to pass a language to screen readers for correct pronunciation**
* charset: iso-8859-1 or UTF-8 (default is UTF-8) **NOTE: rethinking this item, will update after research...**
* language - BCP 47
* charset: Default is UTF-8
* description
* publishDate - ISO 8601 date (ISO 2014): YYYY-MM-DD - do NOT include time (clients may want to add defensive code for this in case auto-generated tools inclue it)
* revisionDate - ISO 8601 date (ISO 2014): YYYY-MM-DD - again, do NOT include time
* publishDate - Format: YYYY-MM-DD eg. 1981-02-01
* revisionDate - Format: YYYY-MM-DD
* version - human readable only, not meant to be parsed
* cover - a jpg or png image which can be anywhere in the directory structure. For accessibility, and also because clipping will occur when maintaining the aspect ratio of the image - do NOT use text in the image.
@ -110,6 +110,14 @@ As well as including appropriate alt-text for images make sure screen readers ar
Images should never include text unless it's repeated as text content immediately above or below.
## Charset
From the Gemini Protocol specification:
> If a MIME type begins with "text/" and no charset is explicitly given, the charset should be assumed to be UTF-8. Compliant clients MUST support UTF-8-encoded text/* responses. Clients MAY optionally support other encodings. Clients receiving a response in a charset they cannot decode SHOULD gracefully inform the user what happened instead of displaying garbage.
Gempub readers should use the same approach.
## Tools
//todo - write ePub to gPub converter