Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add cross-referencing to all rticles #328

Open
etiennebr opened this issue Sep 27, 2020 · 7 comments
Open

Add cross-referencing to all rticles #328

etiennebr opened this issue Sep 27, 2020 · 7 comments
Labels
feature a feature request or enhancement

Comments

@etiennebr
Copy link

I think that it could be easier to use cross-referencing in rticles. References to tables, figures and equations are ubiquitous to scientific papers. bookdown provides a generic solution that, I think, is more likely to bring users to success from the start.

\begin{equation}
(\#eq:eq)
c = a \cdot b
\end{equation}
  
see \@ref(eq:eq)

Gives
image

@cderv suggested that maybe we could provide two possible default outputs in the skeletons. Something like:

output:
  rmarkdown::pdf_document:
    base_format: rticles::mdpi_article
  bookdown::pdf_book: 
    base_format: rticles::mdpi_article

It has the benefit that the default output does not require bookdown, and it shows that other outputs are possible. While cross-referencing would not work from the start, enabling it would be a matter of picking the next output in the list. If using bookdown as the default output is excluded, then I think this solution is pretty good.

Following #327, I believe that the solution might need to be applied to all skeletons.

@etiennebr
Copy link
Author

From #327 (comment)

Make that

output:
  rticles::mdpi_article: default
  bookdown::pdf_book: 
    base_format: rticles::mdpi_article

@cderv
Copy link
Collaborator

cderv commented Sep 27, 2020

Would a vignette in rticles explaining how to use bookdown features by modifying the yaml header be a good idea to better document this ?

@etiennebr
Copy link
Author

I agree that a vignette would be useful since there are so many options from bookdown. I still believe that using bookdown::pdf_book as default would enlarge the pit of success, though.

@sbgraves237

This comment has been minimized.

@etiennebr

This comment has been minimized.

@cderv

This comment has been minimized.

@sbgraves237

This comment has been minimized.

@cderv cderv added the feature a feature request or enhancement label Sep 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

No branches or pull requests

3 participants