Giter Club home page Giter Club logo

paperaj's Introduction

paperaj - Write jounal papers in word and convert to LaTeX for submission!

Paperaj is a combination of bash and python scripts for converting MS word document to a latex document for academic journals. You can use any journal template for latex compilation. This can be used as a standalone script (needs pandoc and latex installed) or as a GitHub action. When used as a GitHub action, there is no need to clone this repository. Just clone this template that uses this GitHub action.

paperaj

How it works

Paperaj creates a set of plain latex files from the word document in the paperaj folder. Images, tables and referencing are supported during the conversion. These plain latex files can be included in the journal's latex template using: \input{filename}. See main.docx in the template for word document format. See main.tex in the template to see how you can include paperaj generated latex files in the latex entry file. Clone this repository only if you want to run this locally (needs pandoc and latex locally). Otherwise just use this template that uses this GitHub action and the GitHub will latex-compile your manuscript!

See main.docx for formatting instructions.

Usage

As GitHub action (recommended)

  • Use this github template
  • Use the docx in the template
  • Add bib and tex files.
  • set the names of docx, bib and latex entry in paperaj.env file
  • This template generates LaTeX files on push to develop branch and compile to PDF on push to main branch!

Local (requires pandoc and latex installed)

  • set the full path of docx, bib and latex entry in paperaj.env file
  • run the script

    ./article.sh paperaj.env

Arguments in .env file

  • BIBLIO=references.bib
  • DOCX=article.docx
  • PDF=article.pdf
  • LATEXFOLDER=./ # no trailing /
  • LATEXENTRY=main.tex
  • BIBCOMPILE=bibtex or biber
  • TEXCOMPILE=defer or yes
  • ACRONYMS=sample.csv
  • GLOSSARY=sample.csv
  • MINDMAP=create
  • CITETAG= cite or citep
  • PANDOCPATH=

Figures

  • Use TWO_COLUMN or LATEXROTATE in captions of figure
  • FIGURE_ or TABLE_ for inline ref

Referencing

\cite{AuthorYEAR} inline

Using Zotero

Flatten into single latex file without inclusions

  • Just create a folder called flatten.

arXiv

  • Add required latex files to arxiv folder.

Clean version for submission

  • The clean latex files without latex comments for submission is in the clean folder.

Mindmapping

  • '** first'

  • '*** second'

  • '**_' adds title

  • Add the above to the Zotero notes for references

Notebook to pdf

  • jupyter-nbconvert --to pdf acnode.ipynb

Extract highlights from PDF

pdfannots

Give us a star ⭐️

If you find this project useful, give us a star. It helps others discover the project.

Contributors

paperaj's People

Contributors

dermatologist avatar

Stargazers

 avatar

Watchers

 avatar  avatar  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.