Git Product home page Git Product logo

emldown's Introduction

emldown

Project Status: Abandoned

This repository has been archived. The former README is now in README-NOT.md.

emldown's People

Contributors

aammd avatar cboettig avatar jhollist avatar karawoo avatar maelle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

emldown's Issues

Dataset template

Create a template that incorporates general information about the dataset (title, abstract, creators, keywords, etc.)

Insert arbitrary HTML into document

Write an R function to do this so we can do fancy things like add leaflet maps. This relates to #15 -- we could use this function to add a map to visualize geographic coverage.

Coverage template

Coverage includes:

  • geographicCoverage
  • temporalCoverage
  • taxonomicCoverage

Render EML function

First step: turn the code in inst/notebook/testing.R into a function.

Next step: add ability to configure e.g. CSS based on YAML

dataTable template

Create a template with information about dataTables. Subcomponents of this include:

  • entityName
  • entityDescription
  • physical
  • attributeList

emldown in reverse?

Could we create EML from markdown?

This was a suggestion from @mbjones in response to examples of the extensive metadata folks seem to be documenting using markdown and .Rmd. (e.g. see this awesome example from @jmlondon http://jmlondon.github.io/kotzeb0912/kotzebue-bearded-seal-telemetry-2009-2012.html)

Sounds like this would require quite a different approach, the XSLT transform strategy is unlikely to be the best route. Might involve exploiting a prescribed header structure or keywords or .Rmd template, and maybe is just a crazy idea. Just wanted to signpost it here for posterity / further discussion before I forgot.

๐Ÿฅ‚

option to produce an html "snippet"

Sometimes, instead of building an entire website, authors might want just a partial one. This would come in handy if, for example, you wanted to include the rendered EML website into another, more complete, website.

This might be done by plugging the essential xslt templates into a simpler, partial ("snippit") HTML file. Then, the function render_eml() would apply one or the other, depending on the value of an argument (something like partial = TRUE)

Template edits

  • remove "Download" button

  • Title to top

  • Involved partners to top

  • Change the order of the sections of the template so that they match the order in the EML

Write tests

I don't really know how to approach testing our output, but we should think about it...

consider reuse/modification of existing XSLT

@maelle @karawoo @aammd @jhollist and others -- I think emldown is awesome ๐ŸŽ‰:tada: :tada: in the way it aims to create a standalone HTML representation of an EML document. I hope the work continues! I've been lurking as you develop the tool, and it seems that work has paused on trying to develop out a more complete XSLT for the complex EML structure.

We have developed an extensive XSLT for transforming EML to HTML, and we reuse that XSLT in multiple places, including our MetacatUI search application, and the Morpho metadata editor, among others. Have you considered re-using this XSLT to generate the base HTML, and then restyle that using CSS and other transforms that make it look how you would like in emldown?

At DataONE, we provide a view service that can run a set of XSLT transforms on a document, and produce an HTML document for further processing. We then add styles to that, and rearrange it with various Javascript DOM manipulations to produce a final product. So, you can see the result of running our XSLT styes on a document by running the view service to produce raw html. The same styles could definitely be run locally in R to produce inital HTML to be further styled and modified in emldown.

Here is an example:

eml-html

eml-rendered

I see you have a bunch of our XSLT files checked into the emldown repo. We (@mbjones, @csjx, @mobb, @amoeba, and many others) been developing XSLT for EML for a long time, and would be happy to help consult on how to get past the significant bottleneck of getting the initial EML to HTML conversion working. Please let us know how we can help. And thanks for the awesome work!

Author list

@carlesmila suggested making it collapsable only when there are more than X authors or depending on an option of the render_eml function.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.