Adjust example references

Author: eltos

.github/increment_version.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+set -e
+cd "$(dirname "${BASH_SOURCE[0]}")/.."
+
+OLD_VERSION=$(awk -F'= *' '/^version/{gsub(/"/,"",$2);gsub("\r","",$2);print $2}' typst.toml)
+NEW_VERSION=$1
+
+echo "Old version: $OLD_VERSION"
+
+if [ -z "${NEW_VERSION}" ]; then
+    read -p "New version: " NEW_VERSION
+else
+    echo "New version: $NEW_VERSION"
+fi
+
+for file in typst.toml README.md template/paper.typ; do
+    sed --debug -i "s|${OLD_VERSION//./\\.}|${NEW_VERSION//./\\.}|" $file
+    git add $file
+done
+
+#git diff --staged
+#git commit -m "Increment Version"
+

jacow.typ

@@ -116,10 +116,11 @@
     else if lower(paper-size) in ("jacow", "test") {(width: 21cm, height: 11in)}
     else {panic("Unsupported paper-size, use 'a4', 'us-letter' or 'jacow'!")}
   )
+  
   // jacow margins slightly increased as per editor request 
   let left-margin = 20mm
-  let column-width = 82.5mm - 0.4mm
-  let column-gutter = 5mm + 0.4mm
+  let column-width = 82.5mm
+  let column-gutter = 5mm
   let bottom-margin = 0.75in + 0.1in
   let column-height = 9.5in - 0.1in
 
@@ -128,14 +129,16 @@
     height: if lower(paper-size) == "test" {auto} else {paper.height},
     margin: (
       left: left-margin,
-      right: paper.width - left-margin - 2*column-width - column-gutter,
+      right: paper.width - left-margin - 2*column-width - column-gutter + 0.4mm,
       top: paper.height - bottom-margin - column-height + 0.005in,
       bottom: bottom-margin + 0.03in
     ),
     columns: 2,
   )
 
-  set columns(gutter: column-gutter)
+  set columns(gutter: column-gutter + 0.4mm)
+
+
 
   set text(
     font: "TeX Gyre Termes",

template/paper.typ

@@ -57,7 +57,7 @@
 
 Typst @typst // a citation to the respective entry in "references.bib" (see below)
 is a great, modern and blazingly fast typesetting system focussed on scientific papers.
-It is markup based, supporting *strong* _emphasis_ of text, #underline[underlining], `monospace` font, smart "quotes" and much more.
+Being markup based, it supports *strong* _emphasis_ of text, #underline[underlining], `monospace` font, smart "quotes" and much more.
 Equations can be typeset inline like $beta_"x" (s)$, and in display mode:
 
 $
@@ -71,7 +71,7 @@ $
   e^("i" pi) + 1 = 0 
 $ <eq:mycustomlabel>
 
-we can reference @eq:mycustomlabel. // a reference to a labelled equation
+they can be referenced as in @eq:mycustomlabel. // a reference to a labelled equation
 The same works for @fig:writer and @table:xydata too.
 Remember to use the long form at the beginning of a sentence:
 @fig:writer[Figure].
@@ -84,7 +84,7 @@ Done.
 The accelerated-jacow template is based on the JACoW paper preparation guide @jacowguide @jacow.org. // citations
 It takes care of proper page size, margins and spacing, generates the front matter with properly formatted title, author list, footnotes and abstract using the show-rule at the top of this document and formats headings, tables, references and more.
 
-Headings are automatically transformed to all-caps and word-caps case as specified by the paper preparation guide.
+Headings are automatically transformed to all-caps and word-caps case respectively.
 Should you require custom control on upper/lower case, this can be forced not only in the title (see above), but also in headings like so:
 
 #let nacl = [#upper[N]#lower[a]#upper[C]#lower[l]]
@@ -146,7 +146,7 @@ These support top, bottom or automatic placement as well.
   box(fill: silver, width: 100%, height: 2cm),
   scope: "parent", // two column-figure
   placement: top, // `top`, `bottom` or `auto` for floating placement or `none` for inline placement
-  caption: [A column spanning figure. #lorem(21)],
+  caption: [A column spanning figure. #lorem(41)],
 ) <fig:rect>
 
 
@@ -192,15 +192,20 @@ With the *lilaq* package, plots can be create directly in the document, so you c
 
 #figure(
   lq.diagram(
-    // sine
+    
+    // plot a sine function
     let x = lq.linspace(0, 10),
     let y = x.map(x => calc.cos(x)),
     lq.plot(x, y, mark: none, label: [$cos(x)$]),
-    // data
+    
+    // plot some data (practically you can load data from a file using `json` etc.)
     lq.plot((1, 2, 3, 7, 9), (-1, 1.8, 0.7, -0.3, 1), yerr: 0.3, mark: "o", stroke: (dash: "dashed"), label: [Data]),
-    // plot layout
+    
+    // adjust plot layout
+    height: 3cm,
     xlabel: [Angle ~ $x$ / rad], xlim: (0, 10),
     ylabel: [$y$ / m], ylim: (-1.5, 2.5),
+    
   ),
   placement: auto, // `top`, `bottom` or `auto` for floating placement or `none` for inline placement
   caption: [A plot create with the Lilaq package directly inside the typst source code]
@@ -229,24 +234,25 @@ For more details, refer to https://typst.app/universe/package/glossy.
 
 
 
-= Conclusions
-#lorem(42)
+= Citations
+Reference formatting uses standard bib files.
+The bib snippets can conveniently be copied by selecting the format type "BibTex" when using the JACoW reference search tool at https://refs.jacow.org/.
+Examples are given below @typst @jacowguide @jacow.org @example-journal-article @example-report @example-book @example-book-chapter @example-thesis @example-jacow-unpublished.
 
-= Acknowledgements
-#lorem(42)
 
 
 
 #bibliography("references.bib")
 
 
+
 // Workaround until balanced columns are available
 // See https://github.com/typst/typst/issues/466
 #place(
   bottom,
   scope: "parent",
   float: true,
-  clearance: 108pt, // TODO: increase clearance for manual column balancing
+  clearance: 70pt, // TODO: increase clearance for manual column balancing
   []
 )
 

template/references.bib

@@ -1,72 +1,52 @@
+
+% Journal article
+@article{example-journal-article,
+  author = {A. Alpha and B. Beta and C. Gamma and D. Delta and E. Eta and F. Zeta},
+  title = {New techniques in accelerators},
+  journal = {Nucl. Instrum. Methods Phys. Res. A},
+  volume = {12},
+  number = {34},
+  pages = {56-78},
+  date = {2009},
+  doi = {10.1016/1234-5678-9},
+}
+
+% Paper in JACoW Proceedings
 @inproceedings{jacowguide,
   author = {A. N. Author and H. Coauthor and P. Contributor},
   title = {Preparation of Papers for {JACoW} Conferences},
-  booktitle = {Proc. 0th Int. Joint Accelerator Conf. (IJAC'00)},
-  pages = {000--999},
-  paper = {JACOW000},
+  booktitle = {Proc. IPAC'00},
   venue = {City, Country, Month 0000},
-  publisher = {JACoW Publishing, Geneva, Switzerland},
+  pages = {000--999},
   doi = {10.18429/JACoW-XXXX},
-  url = {https://github.com/JACoW-org/JACoW_Templates/},
-  language = {english}
 }
 
+% Report
+@techreport{example-report,
+  author = {Z. C. Omega},
+  title = {Title of report},
+  address = {CERN, Geneva, Switzerland},
+  number = {NR-123-XYZ},
+  date = {1999-01},
+  url = {https://cds.cern.ch/record/00000}
+}
+
+% Website
 @online{jacow.org,
-  title = {Joint Accelerator Conferences Website},
+  title = {Joint Accelerator Conferences Website (JACoW)},
+
   url = {https://jacow.org/}
 }
 
+% Software
 @software{typst,
   author = {Mädje, Laurenz and Haug, Martin and {The Typst Project Developers}},
   license = {Apache-2.0},
   title = {{Typst}},
   url = {https://github.com/typst/typst}
 }
 
-@inproceedings{example-jacow,
-  author = {A. N. Author and B. Coauthor and C. Contributor},
-  title = {A novel {TeV} accelerator},
-  booktitle = {Proc. IPAC'00},
-  pages = {000-999},
-  howpublished = {paper ABC123},
-  venue = {City, Country, Month 2000},
-  doi = {10.18429/JACoW-XXXX},
-}
-
-@unpublished{example-jacow-sameconf,
-  author = {A. N. Author and B. Coauthor},
-  title = {A talk at the same conference},
-  note = {presented at IPAC’00, City, Country, Jan. 2000, paper ABC123, this conference},
-}
-
-@unpublished{example-jacow-unpublished,
-  author = {A. N. Author and B. Coauthor},
-  title = {A talk without published paper},
-  note = {presented at IPAC’00, City, Country, Jan. 2000, paper ABC123, unpublished},
-}
-
-@article{example-journal,
-  author = {A. Alpha and B. Beta and C. Gamma and D. Delta and E. Eta and F. Zeta},
-  title = {New techniques in accelerators},
-  journal = {Phys. Rev. ST Accel. Beams},
-  volume = {00},
-  pages = {000000},
-  date = {2000-01},
-  doi = {10.1103/PhysRevAccelBeams.00.000000},
-}
-
-@unpublished{example-journal-unpublished,
-  author = {A. Alpha and B. Beta and C. Gamma and D. Delta and E. Eta and F. Zeta},
-  title = {New techniques in accelerators},
-  note = {submitted for publication},
-}
-
-@misc{example-website,
-  title = {{JACoW}},
-  url = {http://www.jacow.org},
-}
-
-
+% Book
 @book{example-book,
   author = {A. Writer},
   title = {Title of Book},
@@ -75,6 +55,7 @@ @book{example-book
   year = {2000},
 }
 
+% Book chapter
 @inbook{example-book-chapter,
   author = {A. Writer},
   title = {Title of chapter in the book},
@@ -86,14 +67,7 @@ @inbook{example-book-chapter
   pages = {100-200},
 }
 
-@techreport{example-report,
-  author = {Z. Omega},
-  title = {Title of report},
-  institution = {CERN, Geneva, Switzerland},
-  number = {CERN-2000-9999},
-  date = {2000-01},
-}
-
+% Thesis
 @thesis{example-thesis,
   author = {A. Student},
   title = {Title of thesis},
@@ -103,3 +77,10 @@ @thesis{example-thesis
   year = {2014},
 }
 
+% Paper at same conference
+@unpublished{example-jacow-unpublished,
+  author = {A. N. Author and B. Coauthor},
+  title = {A talk at the same conference},
+  note = {presented at IPAC’00, City, Country, Jan. 2000, paper ABC123, this conference},
+}
+