rstudio / rstudio/rticles

Use abstract-to-meta to make it easier to write abstracts

Open
#353 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Writting the batract section in the yaml is a bit cumbersome, it's not clear how to include inline R code, and RStudio auto indent feature doesn't recognise it properly. Recently I found out about the abstract-to-meta lua filter which allows the user to write the abstract as part of the body and then moves that to the metadata :

https://github.com/pandoc/lua-filters/tree/master/abstract-to-meta

It works like a charm. With it it's even possible to write the abstract as the last section of the document, which would make it even more natural to include results from the analysis.

Would you consider transitioning templates into using this filter?


By filing an issue to this repo, I promise that

  • I have fully read the issue guide at https://yihui.name/issue/.
  • I have provided the necessary information about my issue.
    • If I'm asking a question, I have already asked it on Stack Overflow or RStudio Community, waited for at least 24 hours, and included a link to my question there.
    • If I'm filing a bug report, I have included a minimal, self-contained, and reproducible example, and have also included xfun::session_info('rticles'). I have upgraded all my packages to their latest versions (e.g., R, RStudio, and R packages), and also tried the development version: remotes::install_github('rstudio/rticles').
    • If I have posted the same issue elsewhere, I have also mentioned it in this issue.
  • I have learned the Github Markdown syntax, and formatted my issue correctly.

I understand that my issue may be closed if I don't fulfill my promises.

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

Start by reviewing the repository's article templates and how their YAML abstract fields are currently defined. Compare that structure with Pandoc's abstract-to-meta Lua filter, then verify that migrated templates still support inline R and preserve the expected abstract output; done means the templates use the filter without losing existing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, markdown, r, tex, yaml
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.