Skip to content

Latex howto.md

Latest commit

 

History

History
59 lines (30 loc) · 4.57 KB

Latex howto.md

File metadata and controls

59 lines (30 loc) · 4.57 KB

If you have never used LaTeX, start with this "LaTeX in 30 min" webpage offered by Overleaf https://www.overleaf.com/learn/latex/Learn_LaTeX_in_30_minutes Overleaf is the platform on which we can collaboratively edit latex-based articles. When you want to start a new paper or report, go to overleaf.com

Most of the shortcuts and settings described here can be copied and pasted from this overleaf file https://www.overleaf.com/read/zfyqpqsqmcyy#b68997

creating the document

UD CAS supports Overleaf upgraded subscriptions! make sure you get the upgraded subscription thorugh UD so you can activate the "track changes" after you finish your first draft and invite more than one coauthor.

Make sure you name your file something specific: while "thesis" may be unique for you, it is not for me since I am on all of FASTLab thesis documents!

Invite me (and the core coauthors) as an author. Screen Shot 2023-07-22 at 12 24 40 PM

Add the following macros to your header (the top of the document before \begin{document}):

Screen Shot 2024-05-02 at 7 20 54 AM

Then use \new{...} to change or add new text after discussions and suggestions from authors. Authors can use \question{...} to put questions in the text or to flag things that need to be discussed or changes, or checked and add a comment. This is what it will look like

Screen Shot 2023-07-22 at 12 26 56 PM Screen Shot 2023-07-22 at 12 27 17 PM

Consider adding a macro with a different color (like the ones defined above as \new and \question) for each coauthor if its a small number of coauthors: e.g.

Screenshot 2025-02-23 at 12 39 45 PM

latex and common and editorial syntax rules

  • use \autoref{label} instead of \ref: that adds the Figure or Table word before the number as a part of the clickable element. Also remember that journals require figures and tables to be references in the thext in the oreder in which they appear in the journal (i.e. your first figure should be the first figure that you mention in the text etc etc)

  • photometric filter lables (e.g. g) should be italic $g$

  • numbers below 10 should be in letters (in most cases anyways)

  • quotes should be `` ' ' instead of “” in latex (that is 2 single slanted quotes to open, two straight down quotes to close)

  • create macros for common variables you will need to refer to often, so that they are formatted consistently throughout: e.g. kilometer per second as $km s^{-1}$, or SNR for signal-to-noise-ratio if you are writing an data analysis paper, or IoU for Intersection over Union if you are writing a computational paper, or Eta Carinae as $\eta-$ Car if you are writing an astro paper. This is done as follows:

Screen Shot 2024-05-02 at 7 25 28 AM

then simply use \kms when you want to include the km/s units, which will render in $km s^{-1}$. Note however that when you use a macro the next word will appear without a space between. To add a space between the macro and the next word use it as \kms\

citations

  • Use \citep{} if you want the citation to appear in parenthesis: the LSST \citep{ivezic19} => the LSST (Ivezić et al. 2019), this is the most common case.
  • If you however want to integrate the citation in the narrative use \citet{}: As discussed in \citet{Ivezic19} => As discussed in Ivezić et al. (2019).
  • Where you have a parenthetical that also requires a citation use \citealt{} instead of \citep{} (as discussed in \citealt{ivezic19}) => (as discussed in Ivezić et al. 2019)

If your paper is extensively discussing Rubin/LSST include the lsst.bib file as one of your reference files. The file is here https://github.com/lsst/lsst-texmf/blob/main/texmf/bibtex/bib/lsst.bib Screen Shot 2023-07-22 at 12 19 14 PM then include lsst.bib as one of your bib files in `\bibliography{references, lsst}'