Bookdown contest submission: bookdownplus gallery: a web app for displaying and sharing bookdown templates

Publishing Your Results
,
1

The Story

Many years ago, I collected some LaTeX templates when learning LaTeX. However, my interest in LaTeX was gone after submitting my PhD dissertation. I should have deleted these templates if they had not been so small. They would never be useful in the future, I thought.

In 2017, I started writing the book Learning R: R for Rookies . Unexpectedly, MS Word could not satisfy me with the typesetting. You know what I mean if you have experience (and pain) in writing a long book or dissertation with Word. Actually I suffered more, but I do not want to talk about it. I was sure that LaTeX could, but I would rather not use it.

Like a bolt out of the blue, I found bookdown.

From then on, I could not help spending time on this amazing tool. My book was completed with bookdown. My manuscripts, produced by bookdown, were submitted to academic journals and accepted. I wrote my papa-and-son diaries on bookdown.org. All the LaTeX templates were brought back to life: I packed them in an R package: bookdownplus.

Bookdownplus was supppsed to be a shortcut to bookdown. In the recently year, I have been doing my best to provide the beginners (and me) a friendly way to using bookdown. However, I struggled with two annoying problems. The first one is how the users (including me) can easily choose the right template. The second one is how the users (including me) can easily contribute their own templates to bookdownplus.

The web app for bookdownplus is intended to solve these problems. Users can search for elegant bookdown templates of interest, download the template package, and leave their comments. Furthermore, contributors' templates, if submitted to the bookdownplus repository, can view their templates on this website as soon as possible.

In another word, this web app is a showcase of the R bookdownplus package, or a window of bookdown templates.

What is bookdownplus?

bookdownplus is an open-source software package that helps users write many kinds of books and articles, including academic journal articles, theses and dissertations, programming books (especially in R language), even guitar books, chemical equations, mails, calendars, and diaries. bookdownplus works on the basis of bookdown.

You don't know which template to choose? The web app for bookdownplus is a gallery of them, each with a title of the template name.

Share your own templates

If you are willing to share your bookdown templates, just upload them to the bookdownplus repo. They will be displayed in the gallery automatically once accepted.

From the version 1.5, bookdownplus opens a widest-ever door to contributors. Here is how:

  1. Make sure that your template works successfully with bookdown.
  2. Prepare a folder in your working directory by running bookdownplus::share('your_template_name') . Follow the instructions in each subfolder and create the required files.
  • (Mandatory) 'your_template_name/demo.zip' is the compressed file from your bookdown project folder.
  • (Optional) 'your_template_name/showcase/' contains the sample files (e.g. pdf, image files). An image file 'cover.png' is recommended, which will be used as the cover image in the gallery.
  • (Optional) You could write a 'your_template/readme.txt' (in markdown syntax), which will be displayed as the text in the gallery.
  1. Upload your template folder 'your_template_name/' in to 'upload/' of the bookdownplus repo.
  2. Add the template information, including the template name, the contributor's name, and a brief introduction, into 'upload/-list.csv'.
  3. Create a Pull Request to bookdownplus.

Wait for the response, and your template will be available in the gallery. R users can get it easily by clicking the ".zip" link in the gallery, or running

bookdownplus("your_template_name")

Any suggestions? Please contact me!

7 Likes
2

The gallery looks amazing. Thanks for putting all these templates together!

3

Actually, the gallery is more an application of blogdown: I wrote a piece of R script that converts new contributions (if any) of bookdownplus templates to blogdown posts. Will there be a blogdown contest :wink: ?

4

I did think about a blogdown contest. Perhaps around February or March next year.

1 Like
5

The bookdownplus gallery is now open for submission. Anyone is welcome to display her/his bookdown template in the bookdownplus gallery if she/he submits a post to /content/portfolio of the gallery repo following the post template:

---
image: img/portfolio/your_template.png # link to the cover image
title: your_template# name of the template
author: Li Lei # the one who created this template
contributor: Han Meimei # the one who submitted to bookdownplus
download: https://github.com/your_id/your_repo/archive/master.zip # the url of the template
weight: 2
summary: A brief introduction, which appears in the R bookdownplus package.
---

A short introduction to your template, which appears on the home page of bookdownplus gallery.

> Created by the author, submitted by the contributor (demo: [pdf](pdf url), [zip](zip url))

<!--more-->

Details of your package.

Please forget the procedure of 'share your own templates', which seems not friendly.

The accepted submissions will be available in the bookdownplus package:

bookdownplus::get_template()
1 Like