Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Tips of Writing a L
A
T
E
X Paper
Using VS Code & Overleaf V2 as an Example
Ming-Ming Cheng
College of Computer Science, Nankai University
Course materials: https://mmcheng.net/writing/
2022/05/24
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 1 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Table of Contents
1 Overleaf for collaboration
2 Git and TortoiseGit
3 Grammarly
4 VS Code + TexLive
5 Using L
A
T
E
X
6 Figures
7 Checklist
8 Rebuttal
9 Project page
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 2 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Using Overleaf V2 for Joint Working
See also the official tutorial
https://www.overleaf.com/learn/latex/Tutorials
Online collaborative L
A
T
E
X editing
Easy to work with many co-authors
Version control using git sync
Using GitHub for Git based version control
Comments discussion
Comments location, author name, time, and reply
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 3 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Overleaf V2 Interface
Fig.: Website Interface. (Overleaf V2)
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 4 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Avoid Meaningless Account Names
Fig.: Avoid such meaningless names during working with others, email communications, etc. Aca-
demic accounts have additional benefits/discount from commercial companies.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 5 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Direct Git access available in Overleaf V2.
Fig.: Direct Git access is launched in Jan. 2019.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 6 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Overleaf with Git
Fig.: Overleaf version control using Git.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 7 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
TortoiseGit for Windows
Fig.: Windows explore interface with TortoiseGit.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 8 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
TortoiseGit for Windows
Different icons means different status
Icons changes after sync using Git Clone.
Red: on disk version is newer, commit ASAP.
Green: on disk version is up to date.
Sync as ASAP to avoid version conflicts
Default commit to local repository, not online repository.
Following this order: commit, pull, push.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 9 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Break lines to avoid version conflict
Avoid version conflict due to simultaneous editing
Git software discover changes line-by-line
Also makes the writing with pretty hierarchy
Fig.: Break lines ASAP.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 10 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Pay Attention to Warnings in Overleaf
Warnings are often very helpful
Fig.: Confirm every warning.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 11 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Pay Attention to Warnings in Overleaf
Warnings are often very helpful. Confirm every warning.
Fig.: Explicitly disable miss-alarms and use "add to dictionary" if you are confident.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 12 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Grammarly
Prepare: Trying to get a clean pdf: https://www.lin-zheng.com/latex-pure/
Fig.: Remove figures, tables, big equations to fascinate pdf docx.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 13 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Grammarly
Prepare: Use MS Word to open pdf file and save as docx
Fig.: Grammarly plugin in Microsoft Word.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 14 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
VSCode
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 15 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
VS Code Extensions
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 16 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
VS Code Extensions
Fig.: VS Code Git & L
A
T
E
X Extensions.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 17 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
VS Code Git Extensions
Fig.: VS Code Git extensions for version history.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 18 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
VS Code Git Extensions
Fig.: VS Code Git extensions for version history.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 19 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
TexLive
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 20 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Start with a Sample
You don’t have to learn Latex carefully
Simply find some useful examples and start
You can find Latex source of many vision papers here:
https://mmcheng.net/salobj/ or https://www.overleaf.com/read/nkyrytybmzcm
Fig.: A sample paper with online Latex editing.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 21 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Use L
A
T
E
X Command for Uniform Formatting
More examples in https://www.overleaf.com/read/zqttbzknmjrz
Use \newcommand{\cmd}[]{#1}
\newcommand{\figref}[1]{Fig. \ref{#1}}
\newcommand{\tabref}[1]{Tab. \ref{#1}}
\newcommand{\eqnref}[1]{Eq. (\ref{#1})}
\newcommand{\secref}[1]{Sec. \ref{#1}}
\newcommand{\sArt}[1]{state-of-the-art}
\newcommand{\AddImg}[1]{\includegraphics[height=.2\linewidth][#1]}
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 22 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Use L
A
T
E
X Command for Formatting
Adding many images: https://www.overleaf.com/read/zqttbzknmjrz
Fig.: Adding many figures.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 23 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Keep proper file size for sharing
Fig.: The attention maps essentially has low res-
olution. Resize the length to 100px.
Fig.: Use figure compression in Visio to maintain
proper file size.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 24 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Keep proper file size for sharing
Fig.: For images with few color types, png files are smaller, otherwise, using jpg files instead.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 25 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Use L
A
T
E
X Command for Formatting
Adding pretty table https://www.overleaf.com/read/zqttbzknmjrz
Fig.: Adding pretty table.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 26 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Use Strings for Journal/Conference Names
Use @String
@string(CVPR = "IEEE CVPR")
@string(CVPR= "IEEE Conf. Comput. Vis. Pattern Recog.")
@string(CVPRW= "IEEE Conf. Comput. Vis. Pattern Recog. Worksh.")
@string(NIPS= "Adv. Neural Inform. Process. Syst.")
@string(IJCV = "Int. J. Comput. Vis.")
@string(PAMI = "IEEE Trans. Pattern Anal. Mach. Intell.")
%More examples in https://www.overleaf.com/read/pcznwnthsprs
@inproceedings {arbelaez2014multiscale,
title="Multiscale combinatorial grouping",
author="Marques, Ferran and Malik, Jitendra",
booktitle=CVPR,
pages="328–335",
year="2014"
}
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 27 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Reference - Formats
Consist.: Use @String to ensure consistency.
Types: Use “@inproceedings” for conference, and “@Article” for journal.
Warning: Don’t directly copy a bibtex from Google Sch.
Author: Use “and” instead of “,” to separate names.
Priority: Important: Journal > conference > arXiv.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 28 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Using Chinese in L
A
T
E
X
Refer to the demo in http://mmcheng.net/salobj/
Fig.: Prepare a Chinese version ASAP.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 29 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Avoid Large Boring Figure
Fig.: Use smaller figure size or add more information.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 30 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Keep Figure Fonts Similar to the Main Text
Fig.: Avoid too small/big fonts. Many reviewers read printed papers.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 31 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Figure Path and Intermediate Files
Fig.: Set figure path. Key all intermediate files for re-editing.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 32 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Avoid Descriptions without Actual Content
Our method is better than Wang et al. [1].
is better produces more accurate results’.
We propose a novel method XXX.
propose’ imply ‘novel’.
We propose an essential XXX method . . .
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 33 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Checklist: limited novelty
This method is a simple combination of [A] and [B]
Fig.: Properly describe/illustrate your contribution.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 34 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Checklist: limited novelty
Limited novelty, straightforward extension of xxx.
Fig.: Explain why our elegant/simple approach is not straightforward/naive [Cheng et al.,
PAMI’15].
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 35 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Checklist: show results in a better way.
Fig.: Presents figures in a proper way.
Avoid miss-leading descriptions. E.g. epochs vs. run-time.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 36 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Checklist: missing experiments to clarify
The performance gain could
also come from ...
due to ...
come with the cost of ...
how well does this and that ...
sensitive to key parameters ...
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 37 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Checklist: good practice
Source code will be released upon paper acceptance.
Discuss of the limitations.
Theoretical proof regarding what could (not) happen.
Analysis the computational/memory cost.
Try to keep your ideas SHARP.
Avoid defining many unnecessary terms.
Be fair (at lease in form).
Verified every design decision (try to keep simple).
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 38 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Analysis reviewer comments
Keep claim and make a rebuttal
1
What is peer review?
How to rebuttal?
Does rebuttal matter?
1
https://zhuanlan.zhihu.com/p/104298923
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 39 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Analysis reviewer comments
Save comments. No access after rebuttal period!
Suggestion: size 5, Calibri, single line space, no space before&after
paragraph.
Fig.: Highlight key issues with bold&red for better printing.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 40 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Login: https://mmcheng.net/salobj/
Fig.: Online editing using WordPress.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 41 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
An example: https://mmcheng.net/wp-login.php
Fig.: Online editing using WordPress.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 42 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
An example: https://mmcheng.net/salobj/
Fig.: Online editing using WordPress.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 43 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Useful plug-ins: e.g. table press
Fig.: Online editing using WordPress Table Press plug-in.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 44 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Useful plug-ins: e.g. table press
Fig.: Online editing using WordPress Table Press plug-in.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 45 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Useful plug-ins: e.g. Slides Show
Fig.: Online editing using WordPress Slides Show plug-in.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 46 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Useful plug-ins: e.g. Slides Show
Fig.: A good vs. bad example.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 47 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Project page is useful for publish & discuss
Fig.: All questions, issues, etc. must be replied on time.
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 48 / 49
Overleaf Git Grammarly VS Code Latex Figures Checklist Rebuttal Project page
Q & A?
Ming-Ming Cheng Nankai University Tips of Writing a L
A
T
E
X Paper 2022/05/24 49 / 49