Giter VIP home page Giter VIP logo

softwaresaved / software-deposit-guidance Goto Github PK

View Code? Open in Web Editor NEW
0.0 11.0 1.0 6.32 MB

Software Deposit Guidance for Researchers. Contact: mikej888

Home Page: https://softwaresaved.github.io/software-deposit-guidance

License: Other

Shell 3.73% Makefile 23.72% HTML 18.57% Python 32.66% CSS 21.33%
reproducible-research guidelines deposit digital-repository research-data-management research-software

software-deposit-guidance's Issues

Automate SVG => PNG conversion

Currently, this is a manual process, done within an SVG editor. This should be automated, the Makefile (and if applicable README.md) updated, then the PNGs removed from the repository.

Update font to Arial (or similar)

I'm not keen on Times New Roman as a web, or guide, font. I experimented with Arial/Helvetica in css/style.css:

@font-face
{
    font-family: Arial, Helvetica, sans-serif;
}

The changes were visible in HTML but not PDF. Googling proved no help in providing a straightforward solution. Defining the following did work for PDFs too:

body
{
    font-family: Arial, Helvetica, sans-serif;
}

However, line spacing within paragraphs can look inconsistent depending on the presence/absence of footnotes. Experiment with CSS to get a footnote style that does not lead to inconsistent spacing between lines within the same paragraph.

Implement more elegant handling of page breaks

Image width/heights, defined in CSS, and page breaks, defined in Markdown via CSS markup, are used to ensure a heading does not appear at the very bottom of a page or that half a page is empty because an image is too high for the space remaining.

Implement more elegant handling of page breaks to remove the need for using CSS markup in MarkDown.

This may require separate CSS depending on whether the HTML is to be deployed online or is being created as an intermediate step when creating PDFs.

Use inline footnotes in Markdown

pandoc Markdown supports inline footnotes e.g.

^[Example inline footnote with links to [Google](http://www.google.co.uk) and [EPCC](http://www.epcc.ed.ac.uk)]

One advantage of these is that footnote numbering is handled automatically.

Update Markdown documents to move all footnotes to be inline footnotes.

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.