rstudio / rstudio/rticles

templates interoperability

Open
#324 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
TeX
Stars
1.5k
Forks
517
Avg merge
1d 8h
Merged PRs (30d)
5

Description

It would be great to be able to write a markdown file and get an output for different templates (by only changing the output variable in the yaml).

I think this would need a large rethinking of the package logic, though (?)

NB: There is a related project, focused on the author list at first, and you are invited to participate in at https://github.com/jam-schema/jams:

author lists are a pillar of scholarly communication and rewarding system. On the other hand, the number of tools to create scholarly outputs requiring an author list is growing exponentially, with software and dataset being published on top of research manuscripts. Each system gets its own author information entry (and export) points, and they are not talking to each other.

We would like to create a common, open standard that could be used as a transfer point between the different formats, and build tools to transform the metadata from one format to the other.

We are biased toward markdown-based documents, i.e. yaml-formatted metadata, but we are hoping to get more use cases and input from YOU.

We are using Github for asynchronous work, while we try to meet regularly in online meetings.

Please use this form to express your interest and be invited to our next online meeting: https://docs.google.com/forms/d/e/1FAIpQLSfShr9808kUIzUDAtAgJFT_ngDd6myUnWIFDxskWrRp3eBJWA/viewform?usp=sf_link

Julien Colomb, on behalf of the Jams team.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing the package logic for how a markdown file and its YAML output variable select a template, then determine the supported template formats and their interoperability requirements. Done means the output variable can select different templates without rewriting the source markdown.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, markdown, yaml
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.