cline:rules:latex paper example 1 - chunhualiao/public-docs GitHub Wiki

cline

• .clinerules

# LaTeX Paper Writing Guidelines

## Project Structure
- Main paper file: main.tex
- Bibliography: citations.bib
- Section files: 
  - abstract.tex
  - introduction.tex to introduce this paper and contributions
  - approach.tex to explain the proposed technical approach
  - experiment.tex to evaluate the approach using experiments
  - relatedwork.tex to discuss related work
  - conclusion.tex
  - and other sections as appropriate
- figures/ (directory for figures)

## Document Structure  
- Use the article document class for research papers  
- Organize content with \section, \subsection, etc.  
- Use \label and \ref for cross-references  
- Organize content with proper sectioning commands  
- Use \maketitle with proper \title, \author, and \date  

## COMMON PACKAGES TO INCLUDE:  
- amsmath, amssymb for mathematics  
- graphicx for images  
- hyperref for links  
- booktabs for tables  
- biblatex/natbib for citations  
- geometry for page layout 

## LaTeX Best Practices  
- Use consistent notation throughout the paper
- Maintain proper cross-referencing between sections
- Follow consistent citation style
- Keep equations and algorithms properly numbered and referenced

## Writing Style Guidelines
- Maintain academic tone appropriate for systems/program analysis venues
- Use precise technical terminology
- Ensure clear transitions between sections
- Support claims with empirical evidence from evaluation
- Use consistent notation throughout the document  
- Avoid manual spacing with \vspace or \hspace  
- Use proper LaTeX commands for special characters  
- Implement proper theorem environments for mathematical proofs

## Figures and Tables:
- Use vector graphics in figures/ when possible
- Use \includegraphics for figures with proper captions 
- Place figures and tables at the top and bottom of columns.
- Use the abbreviation "Fig." even at the beginning of a sentence.
- Always add \caption and \label to figures and tables  
- Use booktabs package for professional tables  

## MATHEMATICAL CONTENT:  
- Number equations consecutively.
- Italicize Roman symbols for quantities and variables, but not Greek symbols.
- Use \eqref{eq} for equation references.
- Use equation environments for displayed equations  
- Use align environments for multi-line equations  
- Always label equations with \label{eq:descriptive-name}  
- Use \ref{} for cross-references  

## CITATIONS AND REFERENCES:  
- Use BibTeX/BibLaTeX for reference management  
- Format citations with \cite{key} or \textcite{key}  
- Use BibTeX for references with \cite commands  
- Create proper bibliography section 
- Number citations consecutively within brackets \cite{b1}.
- Refer simply to the reference number, as in \cite{b3}.
- Capitalize only the first word in a paper title, except for proper nouns and element symbols.

## File Patterns to Watch
- *.tex files for content
- *.bib for references
- figures/* for diagrams and plots
- Makefile for build instructions

## Quality Checks
- Verify all citations are used and properly formatted
- Check figure/table references
- Ensure consistent terminology across sections
- Validate mathematical notation consistency
- Check for proper section hierarchy and flow

## Build and Compilation
- Use Makefile for building the paper
- Keep intermediate files clean
- Ensure all figures are properly included
- Verify all citations are present in citations.bib