Version 22 (modified by 6 years ago) (diff) | ,
---|
CMDI Best Practices Guide editing procedure
The best practices guide is edited in LaTeX on Overleaf.
Overleaf links for the draft document:
Editing - publication workflow
This document is regularly synchronised with the connected cmdi-best-practices GitHub repository.
Whenever a new version is to be published, new changes are merged into a main repository, from where version are built (via a private Overleaf project) and attached to releases.
Schematical overview:
EDITS SYNC +->>>-MERGE->>>-+ SYNC | | | | | ---+---- | -------------+----- ----+------------- | -------- Overleaf <---> GitHub (draft fork) GitHub (main fork) <---> Overleaf -------- ------------------- ------------------ -------- | | | | +-> Releases <---PDF--+
Draft mode
The guide can be compiled with draft mode either enabled or disabled. To toggle draft mode, change the following line in the MASTER file:
\setboolean{bpdraft}{true}
or
\setboolean{bpdraft}{false}
(default is false
)
Work in progress
Sections that are work in progress can be marked as such which causes them to be visually marked as work in progress in draft mode, and omitted if the document is compiled in on-draft mode. To do so, wrap the content in a workinprogress
block. For example:
\begin{workinprogress} \section{My work in progress section} ... \end{workinprogress}
Attachments (7)
- about.png (189.8 KB) - added by 6 years ago.
- discussion.png (158.6 KB) - added by 6 years ago.
- create-branch.png (57.0 KB) - added by 6 years ago.
- select-branch.png (200.9 KB) - added by 6 years ago.
- changerequest.png (129.2 KB) - added by 6 years ago.
- open-in-editor.png (24.6 KB) - added by 6 years ago.
- create-change-request.png (17.6 KB) - added by 6 years ago.
Download all attachments as: .zip