Giter Club home page Giter Club logo

badger's Introduction

satRdays.org site generator

This repo is used for holding the items needed to generate a static site via Hugo.

The core site repo is a user-level repo so the site HTML has to be stored in master. As such, this repo is used to store the source code and it can used to generate a public folder. The contents of which should be pushed to the satrdays.github.io repo.

Development is being managed via the Projects dashboard.

badger's People

Contributors

brennanpincardiff avatar daveparr avatar dokato avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar

badger's Issues

Can we make this owned by satrdays and not CardiffR?

Thanks for making this @dokato , it was great taht you took the initiative and starting thsi moving. How would you feel if I transferred the ownership of this over to satRdays core? I feel like by putting it there it would gain some visibility and increase the potential for reuse/refinement.

for now I have simply forked it https://github.com/satRdays/badgeR but this means that issues can't be raised and a few other little niggles that means it's not as good a solution.

Refactor the create_badge function to source the template from a tex file instead of being hard coded to the function

Currently create_badge is an 'omni-function' in that is 'does it all'. There are various interfaces that can be broken out, and this could start with a built in tex file to the package which contains the default badge template. Being able to break this out might make it easier for the package to cover multiple different styles of badge, and to potentially maintain and modify the behaviour fo the template.

This work will begin with creating a standalone tex file in a suitable location in the package and then making sure that is sourced correctly into the function.

Adding tests but does it require a little refactoring our code?

Clearly we need some tests but I wonder if it requires some refactoring.

I wonder if it is possible/worthwhile to separate the creation of the temp_badge_code item from the creation of the Latex and perhaps from the generation of the PDF?

This might facilitate some previewing and facilitate some testing.

Maybe into the following functions:

  • make_badge_code()
  • preview_badge()
  • render_badge_pdf()

Thoughts @dokato, @DaveParr?
P

Should we add a 'pronouns' field?

AFAIK we don't support pronouns on badges right now. I think that it would be nice to add this as an option. I imagine that it would be another text field that can theoretically have 'anything' put into it, though as an example values might be as follows (non-exhaustive):

  • He/Him
  • They/Them

Does anyone have any direct experience/ a good reference that might give us more numerous examples?

Adding a badge preview option...

I don't know if this is possible but it would be useful, I think to add a preview option/function.
This would be useful for long names and where custom options are being used.
Is it possible to preview Latex in one of the RStudio windows?

Document installation requirements

We know there are quite a few dependencies for this package to get it to run. Where reasonable we should document an 'installation' process.

For ubuntu I've got this far:

sudo dpkg --configure -a
sudo apt --fix-broken install
sudo apt upgrade
sudo apt-get install texlive-full
sudo apt-get install texinfo

At which point I get an error:

Error in tools::texi2dvi(temp_badge_code, pdf = TRUE, clean = TRUE) : 
  Running 'texi2dvi' on './badgeb414e40e438.tex' failed.
LaTeX errors:
! LaTeX Error: File `ticket.sty' not found.

Type X to quit or <RETURN> to proceed,
or enter new name. (Default extension: sty)

! Emergency stop.
<read *> 
         
l.4 \usepackage
               {graphicx}^^M
!  ==> Fatal error occurred, no output PDF file produced! 

I try to determine if this CTAN package is in the system with: kpsewhich ticket.sty which gives no response, i.e. no package installed. Curiously when I run kpsewhich letter.sty I get: /home/davidparr/.TinyTeX/texmf-dist/tex/latex/base/letter.sty which indicates the tinytex install that I had thought I had removed.

Eitherway, i need to work out how to install this missing package to make it run. Will update this as I make more progress.

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.