Giter Club home page Giter Club logo

doctate's Introduction

Doctate

A convention for improving citations in markdown documents using CURIEs.

When referring to a country, local authority or indeed anything recorded in a GOV.UK register use the <register-name>:<key-value> as a link-label:

[The Czech Republic][country:CZ]
[Ashlyns School][school-eng:117578]
[BT Ltd][company:02216369]
[Cabinet Office][government-organisation:cabinet-office]
[Minister for the Cabinet Office][government-role:minister-for-the-cabinet-office]
[Francis Maude][government-person:francis-maude]

The displayed text can be whatever you like, as can be the shortcut reference, which can be a link to a human-friendly page:

[country:CZ]: https://www.gov.uk/government/world/czech-republic
[school-eng:117578]: https://www.compare-school-performance.service.gov.uk/school/117578
[company:02216369]: https://beta.companieshouse.gov.uk/company/02216369
[government-organisation:cabinet-office]: https://www.gov.uk/government/organisations/cabinet-office
[government-person:francis-maude]: https://www.gov.uk/government/people/francis-maude 
[government-role:minister-for-the-cabinet-office]: https://www.gov.uk/government/ministers/minister-for-the-cabinet-office

The text will be rendered by any markdown processor as follows:

Why would I do this?

Tools can help editors ensure consistent naming in documents and make global changes, for example, to update the text when an organisation changes its name.

Improving the precision of links helps with search and analysis, especially where the same text can refer to multiple things.

We can write markdown processors which use the CURIEs to produce microdata, RDFa, JSON-LD and other annotations.

Example documents

Background

This simple idea won the 'solved problem' prize at the Accountability Hack 2016, though much of the day was spent exploring text mining tools and extending editors, notably Dillinger as tools to support this way of working โ€” see the hackday notes.

doctate's People

Contributors

psd avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

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.