Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# Template for Belle II Notes and Publications
Use this template for writing Belle II notes or publications.
The following instructions tell how to
* [set up the git repository for the document](#git-repository),
* [add the content](#document-editing), and
* [produce the files for review or submission](#document-compilation).
Compile the example note for more detailed instructions.
<br>
## Git repository
The first step is to make a fork of this repository.
Ask [Thomas](mailto:Thomas.Kuhr@lmu.de) to create such a fork.
Include the document identifier in the request to Thomas.
(In urgent cases you can first make a fork in your personal area and give Thomas the rights to move it.)
Get the URL of the **forked** repository (not the template repository) by clicking the blue `Code` button at the right then the copy icon.
If you have added your ssh key to stash (recommended) use `Clone with SSH`, otherwise `Clone with HTTPS`.
Clone the repository to get a local version of the repository:
git clone git@gitlab.desy.de:belle2/documents/belle2-note-xx-yyyy-zzz.git
Tell your colleagues about the repository if you want to share the work on the document.
Use git commands to push and pull changes.
If you want to edit the document with Overleaf see the instructions [below](#overleaf).
Use the command
./update
to get the latest version of acknowledgements or any other update of the template.
As there are three different versions of acknowledgements you have to choose one with the command
./acknowledgements TYPE
where `TYPE` is `1` for Belle only, `2` for Belle II only, and `3` for Belle + Belle II publications.
Rerun this command whenever you have executed the `./update` command.
<br>
## Document editing
It is recommended to use one line per sentence in the latex files because it makes diffs between versions more readable.
### Notes
Use [`note.tex`](note.tex) for Belle II notes.
Insert the note number and version, title, authors, abstract, and main text at the indicated places.
Make sure to increase the version number whenever a new version is released to the collaboration.
The template contains some comments that may help to structure the content of an analysis note.
### Publications
The content of publications is split in multiple files so that a draft version for review and the final version for submission can be produced from them.
Use
* [`title.tex`](title.tex) for the title,
* [`abstract.tex`](abstract.tex) for the abstract,
* [`body.tex`](body.tex) for the main content, and
* [`material.tex`](material.tex) for all further figures and numbers that should be approved for public presentation.
In addition the note information should be added in [`draft.tex`](draft.tex).
Replace the file [`authors.tex`](authors.tex) with the actual author list from the [authorship webpage](https://authors.belle2.org).
### Figures
Put figures in the subdirectory `figures`.
Add them to the git repository with the command
git add figures/*
### References
The file [`references.bib`](references.bib) contains recommended references.
You can add your own references by getting the bibtex information from [INSPIRE HEP](https://inspirehep.net/) with the command
./addref [ID]
with the arXiv number or inspire ID as argument.
<br>
## Document compilation
Use
make [argument]
to produce a pdf file from your latex code.
Without argument or argument `note` it will do the compilation of the note.
For publications use one of the following arguments:
* `draft` to produce a version for review,
* `prl` to produce a version for submission to Physics Review Letters (PRL), see [instructions](https://journals.aps.org/prl/authors) and [style guide](https://journals.aps.org/files/styleguide-pr.pdf),
* `prd` to produce a version for submission to Physics Review D (PRD), see [instructions](https://journals.aps.org/prd/authors) and [style guide](https://journals.aps.org/files/styleguide-pr.pdf),
* `jhep` to produce a version for submission to Journal of High Energy Physics (JHEP), see [instructions]() and [manual](),
* `epjc` to produce a version for submission to The European Physical Journal C (EPJC), see [instructions](https://www.springer.com/journal/10052/submission-guidelines) and [template](https://mc.manuscriptcentral.com/societyimages/epjc/EPJC_templ.zip).
To merge all tex files into one and produce a tarball `paper.tgz` with all files needed for submission use
make [argument].paper
If you want to show the changed between two versions the `latexdiff-git` tool can be used.
For example,
latexdiff-git --pdf --flatten -r 36e3ee54 draft.tex
will produce the file `draft-diff36e3ee54.pdf` with indication of changes with respect to revision 36e3ee54.
<br>
## Overleaf
If you want to edit the document (collaboratively) in [Overleaf](https://www.overleaf.com), you can connect your git repository with an Overleaf document in the following way:
* Create a blank new project in Overleaf.
* Remove `main.tex` by clicking the three dots next to it and then `Delete`.
* Get the git URL of your Overleaf project by clicking `Git` in the `Menu` and then taking the displayed string after `git clone`.
* Run the command `./connect_overleaf` with the git URL as argument in your local repository directory.
Keep your local repository directory to sync changes in Overleaf to the Belle II Docs repository from time to time with the command
./sync_from_overleaf
If you make changes in your local version push them to overleaf with
git push overleaf main:master