Skip to content

EclipsePhaseTools/EP2-Data

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EP2-Data

Eclipse Phase Second Edition Data

This work is licensed under the Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license: https://creativecommons.org/licenses/by-nc-sa/4.0/ as this is the license of the EP2E book.

This repo is following these guidelines:

  • Lowercase keys on objects
  • Avoid abbreviations in keys (e.g. 'description' not 'desc')
  • Include an 'id' attribute (UUIDv4) on objects you're adding to the data for the first time
  • Underscores in keys, not spaces or pascal/camel-case
  • Include information about the source in 'resource' and 'reference' attributes
    • 'resource' is something like the name of the book
    • 'reference' is a locator inside that resource like a page number
  • 2-space tab (not that it matters much)
  • Descriptions (in the 'description' property) are in HTML
  • If an object has a short and long description (short might be from a summary table), then 'summary' and 'description' attributes are short and long respectively, otherwise only 'description'
  • Paragraphical data and lists stored in HTML <p> and <ul>/<li> tags, serialized
  • Every samey object has all the keys, even if only one object needs it (though you should reconsider your structure at that point)

About

Eclipse Phase Second Edition Data

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 50.5%
  • Python 49.5%