miaowware/qrm2
1
0
Fork 0
mirror of https://github.com/miaowware/qrm2.git synced 2024-11-10 18:33:34 -05:00
Code Issues Actions Projects Releases Wiki Activity
96b2a8f259
qrm2/dev-notes/metadata-format.md
0x5c 96b2a8f259
Metadata update! 
- Added flag emojis to commands with countries.
- Added image attribution and description to "image" commands.
- Added file metadata to image resources.
- Added new key in options.py: pika.
- Added classes to deal with file metadata.
- Added common paths to common.py.
- Changed directory/file names of resources.
- Documented the new metadata format.

Fixes #83 - Metadata storage
Fixes #86 - Country flags
2019-12-23 20:51:31 -05:00

1.2 KiB
Raw Blame History

File metadata format

Used for grouping info such as name, description, source, and such.

Format

id is the dictionary key, and the list items are the attributes for each files.

meta.json

{
    "id": ["filename", "name", "long_name", "description", "source", "emoji"]
}
Attribute Description Examples
filename The file name of the file, without the path. ca.png, itu.png
name The name of the file. Canada, ITU Zones
long_name The long name (title) of the file. Worldwide map of ITU Zones
description The description accompanying the file. Full radio allocations chart for all services.
source The source of the file. Instituto Federal de Telecomunicaciones (IFT)
emoji A Unicode emoji associated with the file. 📻, 🇨🇦