princeton-cdh / davilajs Goto Github PK

View Code? Open in Web Editor NEW

0.0 4.0 0.0 1.1 MB

Interactive, Iterative Schema Documentation

Home Page: https://princeton-cdh.github.io/davilajs/

License: Apache License 2.0

Ruby 4.15% HTML 9.30% JavaScript 79.60% SCSS 6.95%

database-schema visualization schema-viewer schema-annotation digital-humanities schema-documentation javascript d3js

davilajs's People

Contributors

Watchers

davilajs's Issues

As a schema viewer, I want to see entities on the force-directed graph colored based on the module they belong to so that I can see how entities group.

As a schema annotator, I want to upload a mysql schema for parsing so that I can view and annotate entities and relationships in my data model.

Via drag and drop; should be able to drop anywhere on the page

As a schema viewer, I want to arrange entities so that I can organize the display in a way that makes sense to me.

Drag is sticky by default - if user drags an entity, it should stay put
Need a way to release back to force-directed placement

As a schema viewer, I want to collapse and uncollapse modules so that I can focus on particular parts of the schema.

As a schema annotator, I want to upload a mysql schema for parsing so that I can view and annotate entities and relationships in my data model.

As a schema annotator, I want to create and edit modules so that I can label groups of entities.

Module = logical grouping (relates to implementation, but not necessarily one to one); label + color only for now
Includes associating entities with modules

As a schema annotator, I want to arrange the diagram and export a static version so that I can embed in documentation and focus on a section of the data model.

Needs to include project metadata & rights

As a schema annotator, I want to annotate entities with a brief description so I can provide a project-specific definition of the entity.

As a schema viewer, I want to collapse and uncollapse entities so that I can read the annotations and see the attributes and data types.

As a schema viewer, I want a visual indicator for the central entity of each module so that I know where I can collapse and uncollapse the module.

As a schema publisher, I want to enter project metadata so that I can document provenance, credit and rights for the data model.

Metadata includes

Name of Project
URL
People and Roles
Date
Documentation license

As a schema publisher, I want to embed my annotated schema into a website so that I can share an interactive version of my annotated data model.

for now, requires schema publisher to have permission to add json files to their website and script tags to their html
need to have documentation about how to add/configure
need a grunt file to build minified version of the js + css to be published on github pages for people to include; should include release version number so that new releases don't break older published content

As a schema viewer, I want to see the entity relationships in a schema displayed as a force directed graph so that I can visualize the data model.

As a schema annotator, I want to view a list of entities from my schema so that I can group them into modules.

As a schema viewer, I want to see the entity relationships in a schema displayed as a force directed graph so that I can visualize the data model.

Entities are collapsed by default (annotations and attributes are hidden)
Modules are not collapsed by default (all entities are visible)

As a schema viewer, I want to collapse and uncollapse entities so that I can read the annotations and see the attributes and data types.

As a schema annotator, I want to load a mysql schema by url for parsing so that I can view and annotate entities and relationships on a schema available online.

As a schema viewer, I want to arrange entities so that I can organize the display in a way that makes sense to me.

As a schema viewer I want to see which attributes are primary keys and foreign keys so I can better understand how the entities relate to each other.

Requires identifying primary and foreign keys when parsing the schema and then changing changing their datatype to "foreign key" or "primary key".

See implementation in DAVILA https://github.com/jabauer/DAVILA/blob/5154f25bceebf3258720780fdcb636817a0bd340/Entity.pde#L84-L106

As a schema viewer I want to see which attributes are primary keys and foreign keys so I can better understand how the entities relate to each other.

As a schema annotator, I want to designate a central entity for each module so that I have way to control the display of the module.

As a schema annotator, I want to choose colors for modules so that I can customize how my schema displays.

(affects all entities and attributes in that module)

Give users free rein to choose colors rather than sticking with existing d3 color palettes; use a color picker if we can. (3pt estimate is to allow for color picker)

As a schema annotator, I want to load a mysql schema by url for parsing so that I can view and annotate entities and relationships on a schema available online.

As a schema publisher, I want to export my schema entities and relationships with associated annotations so that I can publish it elsewhere.

Export as a json file; should include entities & relationships, annotations, project metadata, modules + color coding [not saved configurations/layouts at this point]

JSON export should include a timestamp
export includes project metadata entered in #3

princeton-cdh / davilajs Goto Github PK

davilajs's People

Contributors

Watchers

davilajs's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs