rstudio / rstudio/rticles

Add custom environment for all part after body in MDPI template

Open
#527 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

From https://github.com/rstudio/rticles/pull/515#discussion_r1168874477 with @mps9506

We should allow such environment

::: informedconsent
Any research article describing a study involving humans should contain this 
statement. Please add ``Informed consent was obtained from all subjects 
involved in the study.'' OR ``Patient consent was waived due to REASON 
(please provide a detailed justification).'' OR ``Not applicable'' for 
studies not involving humans. You might also choose to exclude this statement 
if the study did not involve humans.

Written informed consent for publication must be obtained from participating 
patients who can be identified (including by the patients themselves). Please 
state ``Written informed consent has been obtained from the patient(s) to 
publish this paper'' if applicable.
:::

and use Lua to catch those Divs and set them as variables for the Pandoc's template. This is similar idea to this filter https://github.com/pandoc-ext/abstract-section

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 with the MDPI template and the linked pull-request discussion, then review the Pandoc template and the Lua filter approach referenced in the issue. Done means that ::: informedconsent Divs after the body are captured as variables and rendered by the Pandoc template.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, lua
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.