@wentorai/research-plugins 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +204 -0
- package/curated/analysis/README.md +64 -0
- package/curated/domains/README.md +104 -0
- package/curated/literature/README.md +53 -0
- package/curated/research/README.md +62 -0
- package/curated/tools/README.md +87 -0
- package/curated/writing/README.md +61 -0
- package/index.ts +39 -0
- package/mcp-configs/academic-db/ChatSpatial.json +17 -0
- package/mcp-configs/academic-db/academia-mcp.json +17 -0
- package/mcp-configs/academic-db/academic-paper-explorer.json +17 -0
- package/mcp-configs/academic-db/academic-search-mcp-server.json +17 -0
- package/mcp-configs/academic-db/agentinterviews-mcp.json +17 -0
- package/mcp-configs/academic-db/all-in-mcp.json +17 -0
- package/mcp-configs/academic-db/apple-health-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-latex-mcp.json +17 -0
- package/mcp-configs/academic-db/arxiv-mcp-server.json +17 -0
- package/mcp-configs/academic-db/bgpt-mcp.json +17 -0
- package/mcp-configs/academic-db/biomcp.json +17 -0
- package/mcp-configs/academic-db/biothings-mcp.json +17 -0
- package/mcp-configs/academic-db/catalysishub-mcp-server.json +17 -0
- package/mcp-configs/academic-db/clinicaltrialsgov-mcp-server.json +17 -0
- package/mcp-configs/academic-db/deep-research-mcp.json +17 -0
- package/mcp-configs/academic-db/dicom-mcp.json +17 -0
- package/mcp-configs/academic-db/enrichr-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fec-mcp-server.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp-server-themomentum.json +17 -0
- package/mcp-configs/academic-db/fhir-mcp.json +19 -0
- package/mcp-configs/academic-db/gget-mcp.json +17 -0
- package/mcp-configs/academic-db/google-researcher-mcp.json +17 -0
- package/mcp-configs/academic-db/idea-reality-mcp.json +17 -0
- package/mcp-configs/academic-db/legiscan-mcp.json +19 -0
- package/mcp-configs/academic-db/lex.json +17 -0
- package/mcp-configs/ai-platform/Adaptive-Graph-of-Thoughts-MCP-server.json +17 -0
- package/mcp-configs/ai-platform/ai-counsel.json +17 -0
- package/mcp-configs/ai-platform/atlas-mcp-server.json +17 -0
- package/mcp-configs/ai-platform/counsel-mcp.json +17 -0
- package/mcp-configs/ai-platform/cross-llm-mcp.json +17 -0
- package/mcp-configs/ai-platform/gptr-mcp.json +17 -0
- package/mcp-configs/browser/decipher-research-agent.json +17 -0
- package/mcp-configs/browser/deep-research.json +17 -0
- package/mcp-configs/browser/everything-claude-code.json +17 -0
- package/mcp-configs/browser/gpt-researcher.json +17 -0
- package/mcp-configs/browser/heurist-agent-framework.json +17 -0
- package/mcp-configs/data-platform/4everland-hosting-mcp.json +17 -0
- package/mcp-configs/data-platform/context-keeper.json +17 -0
- package/mcp-configs/data-platform/context7.json +19 -0
- package/mcp-configs/data-platform/contextstream-mcp.json +17 -0
- package/mcp-configs/data-platform/email-mcp.json +17 -0
- package/mcp-configs/note-knowledge/ApeRAG.json +17 -0
- package/mcp-configs/note-knowledge/In-Memoria.json +17 -0
- package/mcp-configs/note-knowledge/agent-memory.json +17 -0
- package/mcp-configs/note-knowledge/aimemo.json +17 -0
- package/mcp-configs/note-knowledge/biel-mcp.json +19 -0
- package/mcp-configs/note-knowledge/cognee.json +17 -0
- package/mcp-configs/note-knowledge/context-awesome.json +17 -0
- package/mcp-configs/note-knowledge/context-mcp.json +17 -0
- package/mcp-configs/note-knowledge/conversation-handoff-mcp.json +17 -0
- package/mcp-configs/note-knowledge/cortex.json +17 -0
- package/mcp-configs/note-knowledge/devrag.json +17 -0
- package/mcp-configs/note-knowledge/easy-obsidian-mcp.json +17 -0
- package/mcp-configs/note-knowledge/engram.json +17 -0
- package/mcp-configs/note-knowledge/gnosis-mcp.json +17 -0
- package/mcp-configs/note-knowledge/graphlit-mcp-server.json +19 -0
- package/mcp-configs/reference-mgr/arxiv-cli.json +17 -0
- package/mcp-configs/reference-mgr/arxiv-search-mcp.json +17 -0
- package/mcp-configs/reference-mgr/chiken.json +17 -0
- package/mcp-configs/reference-mgr/claude-scholar.json +17 -0
- package/mcp-configs/reference-mgr/devonthink-mcp.json +17 -0
- package/mcp-configs/registry.json +447 -0
- package/openclaw.plugin.json +21 -0
- package/package.json +61 -0
- package/skills/analysis/dataviz/color-accessibility-guide/SKILL.md +230 -0
- package/skills/analysis/dataviz/geospatial-viz-guide/SKILL.md +218 -0
- package/skills/analysis/dataviz/interactive-viz-guide/SKILL.md +287 -0
- package/skills/analysis/dataviz/network-visualization-guide/SKILL.md +195 -0
- package/skills/analysis/dataviz/publication-figures-guide/SKILL.md +238 -0
- package/skills/analysis/dataviz/python-dataviz-guide/SKILL.md +195 -0
- package/skills/analysis/econometrics/causal-inference-guide/SKILL.md +197 -0
- package/skills/analysis/econometrics/iv-regression-guide/SKILL.md +198 -0
- package/skills/analysis/econometrics/panel-data-guide/SKILL.md +274 -0
- package/skills/analysis/econometrics/robustness-checks/SKILL.md +250 -0
- package/skills/analysis/econometrics/stata-regression/SKILL.md +117 -0
- package/skills/analysis/econometrics/time-series-guide/SKILL.md +235 -0
- package/skills/analysis/statistics/bayesian-statistics-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/hypothesis-testing-guide/SKILL.md +210 -0
- package/skills/analysis/statistics/meta-analysis-guide/SKILL.md +206 -0
- package/skills/analysis/statistics/nonparametric-tests-guide/SKILL.md +221 -0
- package/skills/analysis/statistics/power-analysis-guide/SKILL.md +240 -0
- package/skills/analysis/statistics/sem-guide/SKILL.md +231 -0
- package/skills/analysis/statistics/survival-analysis-guide/SKILL.md +195 -0
- package/skills/analysis/wrangling/missing-data-handling/SKILL.md +224 -0
- package/skills/analysis/wrangling/pandas-data-wrangling/SKILL.md +242 -0
- package/skills/analysis/wrangling/questionnaire-design-guide/SKILL.md +234 -0
- package/skills/analysis/wrangling/text-mining-guide/SKILL.md +225 -0
- package/skills/domains/ai-ml/computer-vision-guide/SKILL.md +213 -0
- package/skills/domains/ai-ml/deep-learning-papers-guide/SKILL.md +200 -0
- package/skills/domains/ai-ml/llm-evaluation-guide/SKILL.md +194 -0
- package/skills/domains/ai-ml/prompt-engineering-research/SKILL.md +233 -0
- package/skills/domains/ai-ml/reinforcement-learning-guide/SKILL.md +254 -0
- package/skills/domains/ai-ml/transformer-architecture-guide/SKILL.md +233 -0
- package/skills/domains/biomedical/clinical-research-guide/SKILL.md +232 -0
- package/skills/domains/biomedical/clinicaltrials-api/SKILL.md +177 -0
- package/skills/domains/biomedical/epidemiology-guide/SKILL.md +200 -0
- package/skills/domains/biomedical/genomics-analysis-guide/SKILL.md +270 -0
- package/skills/domains/business/market-analysis-guide/SKILL.md +112 -0
- package/skills/domains/business/strategic-management-guide/SKILL.md +154 -0
- package/skills/domains/chemistry/computational-chemistry-guide/SKILL.md +266 -0
- package/skills/domains/chemistry/retrosynthesis-guide/SKILL.md +215 -0
- package/skills/domains/cs/algorithms-complexity-guide/SKILL.md +194 -0
- package/skills/domains/cs/dblp-api/SKILL.md +129 -0
- package/skills/domains/cs/software-engineering-research/SKILL.md +218 -0
- package/skills/domains/ecology/biodiversity-data-guide/SKILL.md +296 -0
- package/skills/domains/ecology/conservation-biology-guide/SKILL.md +198 -0
- package/skills/domains/ecology/gbif-api/SKILL.md +158 -0
- package/skills/domains/ecology/inaturalist-api/SKILL.md +173 -0
- package/skills/domains/economics/behavioral-economics-guide/SKILL.md +239 -0
- package/skills/domains/economics/development-economics-guide/SKILL.md +181 -0
- package/skills/domains/economics/fred-api/SKILL.md +189 -0
- package/skills/domains/education/curriculum-design-guide/SKILL.md +144 -0
- package/skills/domains/education/learning-science-guide/SKILL.md +150 -0
- package/skills/domains/finance/financial-data-analysis/SKILL.md +152 -0
- package/skills/domains/finance/quantitative-finance-guide/SKILL.md +151 -0
- package/skills/domains/geoscience/climate-science-guide/SKILL.md +158 -0
- package/skills/domains/geoscience/gis-remote-sensing-guide/SKILL.md +129 -0
- package/skills/domains/humanities/digital-humanities-guide/SKILL.md +181 -0
- package/skills/domains/humanities/philosophy-research-guide/SKILL.md +148 -0
- package/skills/domains/law/courtlistener-api/SKILL.md +213 -0
- package/skills/domains/law/legal-research-guide/SKILL.md +250 -0
- package/skills/domains/math/linear-algebra-applications/SKILL.md +227 -0
- package/skills/domains/math/numerical-methods-guide/SKILL.md +236 -0
- package/skills/domains/math/oeis-api/SKILL.md +158 -0
- package/skills/domains/pharma/clinical-pharmacology-guide/SKILL.md +165 -0
- package/skills/domains/pharma/drug-development-guide/SKILL.md +177 -0
- package/skills/domains/physics/computational-physics-guide/SKILL.md +300 -0
- package/skills/domains/physics/nasa-ads-api/SKILL.md +150 -0
- package/skills/domains/physics/quantum-computing-guide/SKILL.md +234 -0
- package/skills/domains/social-science/social-research-methods/SKILL.md +194 -0
- package/skills/domains/social-science/survey-research-guide/SKILL.md +182 -0
- package/skills/literature/discovery/citation-alert-guide/SKILL.md +154 -0
- package/skills/literature/discovery/conference-proceedings-guide/SKILL.md +142 -0
- package/skills/literature/discovery/literature-mapping-guide/SKILL.md +175 -0
- package/skills/literature/discovery/paper-tracking-guide/SKILL.md +211 -0
- package/skills/literature/discovery/rss-paper-feeds/SKILL.md +214 -0
- package/skills/literature/discovery/semantic-scholar-recs-guide/SKILL.md +164 -0
- package/skills/literature/fulltext/doaj-api/SKILL.md +120 -0
- package/skills/literature/fulltext/interlibrary-loan-guide/SKILL.md +163 -0
- package/skills/literature/fulltext/open-access-guide/SKILL.md +183 -0
- package/skills/literature/fulltext/pmc-oai-api/SKILL.md +184 -0
- package/skills/literature/fulltext/preprint-servers-guide/SKILL.md +128 -0
- package/skills/literature/fulltext/repository-harvesting-guide/SKILL.md +207 -0
- package/skills/literature/fulltext/unpaywall-api/SKILL.md +113 -0
- package/skills/literature/metadata/altmetrics-guide/SKILL.md +132 -0
- package/skills/literature/metadata/citation-network-guide/SKILL.md +236 -0
- package/skills/literature/metadata/crossref-api/SKILL.md +133 -0
- package/skills/literature/metadata/datacite-api/SKILL.md +126 -0
- package/skills/literature/metadata/doi-resolution-guide/SKILL.md +168 -0
- package/skills/literature/metadata/h-index-guide/SKILL.md +183 -0
- package/skills/literature/metadata/journal-metrics-guide/SKILL.md +188 -0
- package/skills/literature/metadata/opencitations-api/SKILL.md +128 -0
- package/skills/literature/metadata/orcid-api/SKILL.md +136 -0
- package/skills/literature/metadata/orcid-integration-guide/SKILL.md +178 -0
- package/skills/literature/search/arxiv-api/SKILL.md +95 -0
- package/skills/literature/search/biorxiv-api/SKILL.md +123 -0
- package/skills/literature/search/boolean-search-guide/SKILL.md +199 -0
- package/skills/literature/search/citation-chaining-guide/SKILL.md +148 -0
- package/skills/literature/search/database-comparison-guide/SKILL.md +100 -0
- package/skills/literature/search/europe-pmc-api/SKILL.md +120 -0
- package/skills/literature/search/google-scholar-guide/SKILL.md +182 -0
- package/skills/literature/search/mesh-terms-guide/SKILL.md +164 -0
- package/skills/literature/search/openalex-api/SKILL.md +134 -0
- package/skills/literature/search/pubmed-api/SKILL.md +130 -0
- package/skills/literature/search/scientify-literature-survey/SKILL.md +203 -0
- package/skills/literature/search/semantic-scholar-api/SKILL.md +134 -0
- package/skills/literature/search/systematic-search-strategy/SKILL.md +214 -0
- package/skills/research/automation/ai-scientist-guide/SKILL.md +228 -0
- package/skills/research/automation/data-collection-automation/SKILL.md +248 -0
- package/skills/research/automation/research-workflow-automation/SKILL.md +266 -0
- package/skills/research/deep-research/meta-synthesis-guide/SKILL.md +174 -0
- package/skills/research/deep-research/research-cog/SKILL.md +153 -0
- package/skills/research/deep-research/scoping-review-guide/SKILL.md +217 -0
- package/skills/research/deep-research/systematic-review-guide/SKILL.md +250 -0
- package/skills/research/funding/figshare-api/SKILL.md +163 -0
- package/skills/research/funding/grant-writing-guide/SKILL.md +233 -0
- package/skills/research/funding/nsf-grant-guide/SKILL.md +206 -0
- package/skills/research/funding/open-science-guide/SKILL.md +255 -0
- package/skills/research/funding/zenodo-api/SKILL.md +174 -0
- package/skills/research/methodology/action-research-guide/SKILL.md +201 -0
- package/skills/research/methodology/experimental-design-guide/SKILL.md +236 -0
- package/skills/research/methodology/grad-school-guide/SKILL.md +182 -0
- package/skills/research/methodology/grounded-theory-guide/SKILL.md +171 -0
- package/skills/research/methodology/mixed-methods-guide/SKILL.md +208 -0
- package/skills/research/methodology/qualitative-research-guide/SKILL.md +234 -0
- package/skills/research/methodology/scientify-idea-generation/SKILL.md +222 -0
- package/skills/research/paper-review/paper-reading-assistant/SKILL.md +266 -0
- package/skills/research/paper-review/peer-review-guide/SKILL.md +227 -0
- package/skills/research/paper-review/rebuttal-writing-guide/SKILL.md +185 -0
- package/skills/research/paper-review/scientify-write-review-paper/SKILL.md +209 -0
- package/skills/tools/code-exec/jupyter-notebook-guide/SKILL.md +178 -0
- package/skills/tools/code-exec/python-reproducibility-guide/SKILL.md +341 -0
- package/skills/tools/code-exec/r-reproducibility-guide/SKILL.md +236 -0
- package/skills/tools/code-exec/sandbox-execution-guide/SKILL.md +221 -0
- package/skills/tools/diagram/mermaid-diagram-guide/SKILL.md +269 -0
- package/skills/tools/diagram/plantuml-guide/SKILL.md +397 -0
- package/skills/tools/diagram/scientific-illustration-guide/SKILL.md +225 -0
- package/skills/tools/document/anystyle-api/SKILL.md +199 -0
- package/skills/tools/document/grobid-pdf-parsing/SKILL.md +294 -0
- package/skills/tools/document/markdown-academic-guide/SKILL.md +217 -0
- package/skills/tools/document/pdf-extraction-guide/SKILL.md +321 -0
- package/skills/tools/knowledge-graph/knowledge-graph-construction/SKILL.md +306 -0
- package/skills/tools/knowledge-graph/ontology-design-guide/SKILL.md +214 -0
- package/skills/tools/knowledge-graph/rag-methodology-guide/SKILL.md +325 -0
- package/skills/tools/ocr-translate/formula-recognition-guide/SKILL.md +367 -0
- package/skills/tools/ocr-translate/handwriting-recognition-guide/SKILL.md +211 -0
- package/skills/tools/ocr-translate/latex-ocr-guide/SKILL.md +204 -0
- package/skills/tools/ocr-translate/multilingual-research-guide/SKILL.md +234 -0
- package/skills/tools/scraping/academic-web-scraping/SKILL.md +326 -0
- package/skills/tools/scraping/api-data-collection-guide/SKILL.md +301 -0
- package/skills/tools/scraping/web-scraping-ethics-guide/SKILL.md +250 -0
- package/skills/writing/citation/bibtex-management-guide/SKILL.md +246 -0
- package/skills/writing/citation/citation-style-guide/SKILL.md +248 -0
- package/skills/writing/citation/reference-manager-comparison/SKILL.md +208 -0
- package/skills/writing/citation/zotero-api/SKILL.md +188 -0
- package/skills/writing/composition/abstract-writing-guide/SKILL.md +188 -0
- package/skills/writing/composition/discussion-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/introduction-writing-guide/SKILL.md +194 -0
- package/skills/writing/composition/literature-review-writing/SKILL.md +196 -0
- package/skills/writing/composition/methods-section-guide/SKILL.md +185 -0
- package/skills/writing/composition/response-to-reviewers/SKILL.md +215 -0
- package/skills/writing/composition/scientific-writing-guide/SKILL.md +152 -0
- package/skills/writing/latex/bibliography-management-guide/SKILL.md +206 -0
- package/skills/writing/latex/latex-drawing-guide/SKILL.md +234 -0
- package/skills/writing/latex/latex-ecosystem-guide/SKILL.md +240 -0
- package/skills/writing/latex/math-typesetting-guide/SKILL.md +231 -0
- package/skills/writing/latex/overleaf-collaboration-guide/SKILL.md +211 -0
- package/skills/writing/latex/tikz-diagrams-guide/SKILL.md +211 -0
- package/skills/writing/polish/academic-translation-guide/SKILL.md +175 -0
- package/skills/writing/polish/academic-writing-refiner/SKILL.md +143 -0
- package/skills/writing/polish/ai-writing-humanizer/SKILL.md +178 -0
- package/skills/writing/polish/grammar-checker-guide/SKILL.md +184 -0
- package/skills/writing/polish/plagiarism-detection-guide/SKILL.md +167 -0
- package/skills/writing/templates/beamer-presentation-guide/SKILL.md +263 -0
- package/skills/writing/templates/conference-paper-template/SKILL.md +219 -0
- package/skills/writing/templates/thesis-template-guide/SKILL.md +200 -0
- package/skills/writing/templates/thesis-writing-guide/SKILL.md +220 -0
- package/src/tools/arxiv.ts +131 -0
- package/src/tools/crossref.ts +112 -0
- package/src/tools/openalex.ts +174 -0
- package/src/tools/pubmed.ts +166 -0
- package/src/tools/semantic-scholar.ts +108 -0
- package/src/tools/unpaywall.ts +58 -0
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: latex-ecosystem-guide
|
|
3
|
+
description: "Comprehensive guide to LaTeX editors, packages, and typesetting workflows"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "📐"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "latex"
|
|
9
|
+
keywords: ["LaTeX typesetting", "LaTeX template", "LaTeX package management", "online LaTeX editor"]
|
|
10
|
+
source: "https://github.com/egeerardyn/awesome-LaTeX"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# LaTeX Ecosystem Guide
|
|
14
|
+
|
|
15
|
+
## Overview
|
|
16
|
+
|
|
17
|
+
LaTeX remains the gold standard for typesetting academic documents in mathematics, computer science, physics, and engineering. Its precise control over document layout, equation rendering, and bibliography management makes it indispensable for journal and conference submissions.
|
|
18
|
+
|
|
19
|
+
This guide consolidates the best resources from the awesome-LaTeX repository (1,600+ stars) into an actionable reference covering editors, essential packages, document classes, bibliography management, and workflow optimization. Whether you are a LaTeX beginner setting up your first paper or an experienced user looking to streamline your pipeline, this skill provides the tools and techniques you need.
|
|
20
|
+
|
|
21
|
+
The LaTeX ecosystem is vast -- over 6,000 packages on CTAN alone. Rather than cataloging everything, this guide focuses on the packages and tools that researchers use most frequently and the workflows that save the most time.
|
|
22
|
+
|
|
23
|
+
## Editors and IDEs
|
|
24
|
+
|
|
25
|
+
### Editor Comparison
|
|
26
|
+
|
|
27
|
+
| Editor | Platform | Real-time Preview | Collaboration | Free |
|
|
28
|
+
|--------|----------|-------------------|---------------|------|
|
|
29
|
+
| Overleaf | Web | Yes | Real-time | Yes (limited) |
|
|
30
|
+
| TeXstudio | Desktop | Compile-based | No | Yes |
|
|
31
|
+
| VS Code + LaTeX Workshop | Desktop | Yes (SyncTeX) | Live Share | Yes |
|
|
32
|
+
| Texifier | macOS/iOS | Live | No | Paid |
|
|
33
|
+
| Vim + VimTeX | Terminal | Zathura/Skim | No | Yes |
|
|
34
|
+
|
|
35
|
+
### Recommended Setup: VS Code + LaTeX Workshop
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
// .vscode/settings.json
|
|
39
|
+
{
|
|
40
|
+
"latex-workshop.latex.autoBuild.run": "onSave",
|
|
41
|
+
"latex-workshop.latex.recipe.default": "latexmk (xelatex)",
|
|
42
|
+
"latex-workshop.latex.recipes": [
|
|
43
|
+
{
|
|
44
|
+
"name": "latexmk (xelatex)",
|
|
45
|
+
"tools": ["latexmk-xelatex"]
|
|
46
|
+
}
|
|
47
|
+
],
|
|
48
|
+
"latex-workshop.latex.tools": [
|
|
49
|
+
{
|
|
50
|
+
"name": "latexmk-xelatex",
|
|
51
|
+
"command": "latexmk",
|
|
52
|
+
"args": [
|
|
53
|
+
"-xelatex",
|
|
54
|
+
"-synctex=1",
|
|
55
|
+
"-interaction=nonstopmode",
|
|
56
|
+
"-file-line-error",
|
|
57
|
+
"%DOC%"
|
|
58
|
+
]
|
|
59
|
+
}
|
|
60
|
+
],
|
|
61
|
+
"latex-workshop.view.pdf.viewer": "tab"
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Essential Packages
|
|
66
|
+
|
|
67
|
+
### Document Structure
|
|
68
|
+
|
|
69
|
+
```latex
|
|
70
|
+
\usepackage[margin=1in]{geometry} % Page margins
|
|
71
|
+
\usepackage{setspace} % Line spacing
|
|
72
|
+
\usepackage{fancyhdr} % Headers and footers
|
|
73
|
+
\usepackage{titlesec} % Section heading styles
|
|
74
|
+
\usepackage[hidelinks]{hyperref} % Clickable cross-references
|
|
75
|
+
\usepackage{cleveref} % Smart cross-references (\cref)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Mathematics
|
|
79
|
+
|
|
80
|
+
```latex
|
|
81
|
+
\usepackage{amsmath} % Core math environments
|
|
82
|
+
\usepackage{amssymb} % Extended symbols
|
|
83
|
+
\usepackage{amsthm} % Theorem environments
|
|
84
|
+
\usepackage{mathtools} % Extensions to amsmath
|
|
85
|
+
\usepackage{bm} % Bold math symbols
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Figures and Tables
|
|
89
|
+
|
|
90
|
+
```latex
|
|
91
|
+
\usepackage{graphicx} % Include images
|
|
92
|
+
\usepackage{subcaption} % Subfigures
|
|
93
|
+
\usepackage{booktabs} % Professional tables (\toprule, \midrule, \bottomrule)
|
|
94
|
+
\usepackage{multirow} % Multi-row cells
|
|
95
|
+
\usepackage{siunitx} % SI units and number formatting
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Code Listings
|
|
99
|
+
|
|
100
|
+
```latex
|
|
101
|
+
\usepackage{listings} % Basic code listings
|
|
102
|
+
\usepackage{minted} % Syntax-highlighted code (requires Pygments)
|
|
103
|
+
\usepackage{algorithm2e} % Algorithm pseudocode
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Document Classes for Research
|
|
107
|
+
|
|
108
|
+
| Class | Use Case | Key Feature |
|
|
109
|
+
|-------|----------|-------------|
|
|
110
|
+
| `article` | Short papers, preprints | Standard LaTeX |
|
|
111
|
+
| `revtex4-2` | APS journals (Phys Rev) | Built-in journal styles |
|
|
112
|
+
| `IEEEtran` | IEEE conferences/journals | Two-column, IEEE format |
|
|
113
|
+
| `acmart` | ACM conferences/journals | Multiple formats (sigconf, sigplan) |
|
|
114
|
+
| `elsarticle` | Elsevier journals | Preprint and journal modes |
|
|
115
|
+
| `svjour3` | Springer journals | Springer Nature format |
|
|
116
|
+
| `aaai` | AAAI conference | AAAI formatting |
|
|
117
|
+
|
|
118
|
+
### Example: ACM Conference Paper
|
|
119
|
+
|
|
120
|
+
```latex
|
|
121
|
+
\documentclass[sigconf,review]{acmart}
|
|
122
|
+
|
|
123
|
+
\begin{document}
|
|
124
|
+
\title{Your Paper Title}
|
|
125
|
+
\author{First Author}
|
|
126
|
+
\affiliation{%
|
|
127
|
+
\institution{University Name}
|
|
128
|
+
\city{City}
|
|
129
|
+
\country{Country}
|
|
130
|
+
}
|
|
131
|
+
\email{author@university.edu}
|
|
132
|
+
|
|
133
|
+
\begin{abstract}
|
|
134
|
+
Your abstract here.
|
|
135
|
+
\end{abstract}
|
|
136
|
+
|
|
137
|
+
\maketitle
|
|
138
|
+
\section{Introduction}
|
|
139
|
+
...
|
|
140
|
+
\end{document}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Bibliography Management
|
|
144
|
+
|
|
145
|
+
### BibLaTeX + Biber (Recommended)
|
|
146
|
+
|
|
147
|
+
```latex
|
|
148
|
+
\usepackage[
|
|
149
|
+
backend=biber,
|
|
150
|
+
style=numeric-comp,
|
|
151
|
+
sorting=none,
|
|
152
|
+
maxbibnames=99
|
|
153
|
+
]{biblatex}
|
|
154
|
+
\addbibresource{refs.bib}
|
|
155
|
+
|
|
156
|
+
% In document body:
|
|
157
|
+
As shown in prior work~\cite{vaswani2017attention}...
|
|
158
|
+
|
|
159
|
+
% At the end:
|
|
160
|
+
\printbibliography
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Quick Reference: BibTeX Entry Types
|
|
164
|
+
|
|
165
|
+
```bibtex
|
|
166
|
+
@article{key,
|
|
167
|
+
author = {Last, First and Last2, First2},
|
|
168
|
+
title = {Paper Title},
|
|
169
|
+
journal = {Journal Name},
|
|
170
|
+
year = {2024},
|
|
171
|
+
volume = {42},
|
|
172
|
+
pages = {1--15},
|
|
173
|
+
doi = {10.xxxx/xxxxx}
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
@inproceedings{key2,
|
|
177
|
+
author = {Last, First},
|
|
178
|
+
title = {Conference Paper Title},
|
|
179
|
+
booktitle = {Proceedings of Conference},
|
|
180
|
+
year = {2024},
|
|
181
|
+
pages = {100--110}
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## Workflow Automation
|
|
186
|
+
|
|
187
|
+
### Makefile for LaTeX Projects
|
|
188
|
+
|
|
189
|
+
```makefile
|
|
190
|
+
MAIN = paper
|
|
191
|
+
TEX = $(MAIN).tex
|
|
192
|
+
PDF = $(MAIN).pdf
|
|
193
|
+
|
|
194
|
+
.PHONY: all clean watch
|
|
195
|
+
|
|
196
|
+
all: $(PDF)
|
|
197
|
+
|
|
198
|
+
$(PDF): $(TEX) refs.bib
|
|
199
|
+
latexmk -xelatex -interaction=nonstopmode $(TEX)
|
|
200
|
+
|
|
201
|
+
clean:
|
|
202
|
+
latexmk -C
|
|
203
|
+
|
|
204
|
+
watch:
|
|
205
|
+
latexmk -xelatex -pvc -interaction=nonstopmode $(TEX)
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Git Integration for LaTeX
|
|
209
|
+
|
|
210
|
+
```bash
|
|
211
|
+
# .gitignore for LaTeX projects
|
|
212
|
+
*.aux
|
|
213
|
+
*.bbl
|
|
214
|
+
*.blg
|
|
215
|
+
*.log
|
|
216
|
+
*.out
|
|
217
|
+
*.synctex.gz
|
|
218
|
+
*.fdb_latexmk
|
|
219
|
+
*.fls
|
|
220
|
+
*.toc
|
|
221
|
+
*.nav
|
|
222
|
+
*.snm
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## Best Practices
|
|
226
|
+
|
|
227
|
+
- **Use `latexmk` instead of manual compilation chains.** It handles multi-pass compilation automatically.
|
|
228
|
+
- **Prefer `booktabs` for tables.** Never use vertical lines (`|`) in academic tables.
|
|
229
|
+
- **Use `\cref{}` from cleveref.** It automatically prepends "Figure," "Table," or "Equation."
|
|
230
|
+
- **Keep one sentence per line in source files.** This makes Git diffs readable and merges cleaner.
|
|
231
|
+
- **Pin your TeX distribution version.** Use Docker or Nix to ensure reproducible builds across machines.
|
|
232
|
+
- **Store figures as PDF or SVG for vector graphics, PNG for raster.** Never upscale low-resolution images.
|
|
233
|
+
|
|
234
|
+
## References
|
|
235
|
+
|
|
236
|
+
- [awesome-LaTeX](https://github.com/egeerardyn/awesome-LaTeX) -- Curated list of LaTeX resources (1,600+ stars)
|
|
237
|
+
- [CTAN](https://ctan.org/) -- Comprehensive TeX Archive Network
|
|
238
|
+
- [LaTeX Wikibook](https://en.wikibooks.org/wiki/LaTeX) -- Community-maintained reference
|
|
239
|
+
- [Overleaf Documentation](https://www.overleaf.com/learn) -- Tutorials and templates
|
|
240
|
+
- [LaTeX Workshop for VS Code](https://github.com/James-Yu/LaTeX-Workshop) -- VS Code extension
|
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: math-typesetting-guide
|
|
3
|
+
description: "LaTeX math typesetting, equation formatting, and cross-referencing"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "sigma"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "latex"
|
|
9
|
+
keywords: ["LaTeX math typesetting", "equation formatting", "mathematical notation", "cross-reference"]
|
|
10
|
+
source: "wentor-research-plugins"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Math Typesetting Guide
|
|
14
|
+
|
|
15
|
+
Comprehensive reference for typesetting mathematical notation, equations, and theorems in LaTeX with correct formatting, numbering, and cross-referencing.
|
|
16
|
+
|
|
17
|
+
## Essential Packages
|
|
18
|
+
|
|
19
|
+
```latex
|
|
20
|
+
\usepackage{amsmath} % Core math environments (align, gather, etc.)
|
|
21
|
+
\usepackage{amssymb} % Additional math symbols
|
|
22
|
+
\usepackage{amsthm} % Theorem environments
|
|
23
|
+
\usepackage{mathtools} % Extensions to amsmath (dcases, coloneqq, etc.)
|
|
24
|
+
\usepackage{bm} % Bold math symbols (\bm{x})
|
|
25
|
+
\usepackage{bbm} % Blackboard bold for indicators (\mathbbm{1})
|
|
26
|
+
\usepackage{nicefrac} % Inline fractions (\nicefrac{1}{2})
|
|
27
|
+
\usepackage{siunitx} % SI units (\SI{9.8}{m/s^2})
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Inline vs. Display Math
|
|
31
|
+
|
|
32
|
+
### Inline Math
|
|
33
|
+
|
|
34
|
+
Use `$...$` or `\(...\)` for math within text:
|
|
35
|
+
|
|
36
|
+
```latex
|
|
37
|
+
The loss function $\mathcal{L}(\theta) = -\sum_{i=1}^{N} \log p(y_i | x_i; \theta)$
|
|
38
|
+
minimizes the negative log-likelihood.
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Display Math (Unnumbered)
|
|
42
|
+
|
|
43
|
+
Use `\[...\]` for centered, unnumbered equations:
|
|
44
|
+
|
|
45
|
+
```latex
|
|
46
|
+
\[
|
|
47
|
+
\nabla_\theta \mathcal{L}(\theta) = -\frac{1}{N} \sum_{i=1}^{N}
|
|
48
|
+
\nabla_\theta \log p(y_i | x_i; \theta)
|
|
49
|
+
\]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Display Math (Numbered)
|
|
53
|
+
|
|
54
|
+
Use the `equation` environment for numbered equations:
|
|
55
|
+
|
|
56
|
+
```latex
|
|
57
|
+
\begin{equation}
|
|
58
|
+
E = mc^2
|
|
59
|
+
\label{eq:einstein}
|
|
60
|
+
\end{equation}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Reference with `\eqref{eq:einstein}` to produce "(1)" with parentheses automatically.
|
|
64
|
+
|
|
65
|
+
## Multi-Line Equations
|
|
66
|
+
|
|
67
|
+
### align Environment
|
|
68
|
+
|
|
69
|
+
Use `align` for multi-line equations with alignment points (`&`):
|
|
70
|
+
|
|
71
|
+
```latex
|
|
72
|
+
\begin{align}
|
|
73
|
+
\mathcal{L}(\theta) &= \mathbb{E}_{(x,y) \sim \mathcal{D}} \left[ \ell(f_\theta(x), y) \right] \label{eq:loss} \\
|
|
74
|
+
&= \frac{1}{N} \sum_{i=1}^{N} \ell(f_\theta(x_i), y_i) \label{eq:empirical-loss} \\
|
|
75
|
+
&\approx \frac{1}{B} \sum_{j=1}^{B} \ell(f_\theta(x_j), y_j) \label{eq:minibatch-loss}
|
|
76
|
+
\end{align}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Use `align*` for unnumbered multi-line equations. Use `\nonumber` to suppress numbering on specific lines.
|
|
80
|
+
|
|
81
|
+
### split Environment
|
|
82
|
+
|
|
83
|
+
Use `split` inside `equation` for a single equation number spanning multiple lines:
|
|
84
|
+
|
|
85
|
+
```latex
|
|
86
|
+
\begin{equation}
|
|
87
|
+
\begin{split}
|
|
88
|
+
\text{ELBO}(\theta, \phi; x) &= \mathbb{E}_{q_\phi(z|x)} \left[ \log p_\theta(x|z) \right] \\
|
|
89
|
+
&\quad - D_\text{KL}\left( q_\phi(z|x) \| p(z) \right)
|
|
90
|
+
\end{split}
|
|
91
|
+
\label{eq:elbo}
|
|
92
|
+
\end{equation}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### cases Environment
|
|
96
|
+
|
|
97
|
+
For piecewise functions:
|
|
98
|
+
|
|
99
|
+
```latex
|
|
100
|
+
\begin{equation}
|
|
101
|
+
\text{ReLU}(x) =
|
|
102
|
+
\begin{cases}
|
|
103
|
+
x & \text{if } x > 0 \\
|
|
104
|
+
0 & \text{otherwise}
|
|
105
|
+
\end{cases}
|
|
106
|
+
\label{eq:relu}
|
|
107
|
+
\end{equation}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Common Mathematical Notation
|
|
111
|
+
|
|
112
|
+
### Symbols Reference Table
|
|
113
|
+
|
|
114
|
+
| Notation | LaTeX | Category |
|
|
115
|
+
|----------|-------|----------|
|
|
116
|
+
| Real numbers | `\mathbb{R}` | Sets |
|
|
117
|
+
| Integers | `\mathbb{Z}` | Sets |
|
|
118
|
+
| Natural numbers | `\mathbb{N}` | Sets |
|
|
119
|
+
| Expectation | `\mathbb{E}` | Probability |
|
|
120
|
+
| Probability | `\mathbb{P}` or `\Pr` | Probability |
|
|
121
|
+
| Normal distribution | `\mathcal{N}(\mu, \sigma^2)` | Distributions |
|
|
122
|
+
| Partial derivative | `\frac{\partial f}{\partial x}` | Calculus |
|
|
123
|
+
| Gradient | `\nabla f` | Calculus |
|
|
124
|
+
| Matrix transpose | `\mathbf{A}^\top` | Linear algebra |
|
|
125
|
+
| Matrix inverse | `\mathbf{A}^{-1}` | Linear algebra |
|
|
126
|
+
| Frobenius norm | `\|\mathbf{A}\|_F` | Linear algebra |
|
|
127
|
+
| L2 norm | `\|\mathbf{x}\|_2` | Linear algebra |
|
|
128
|
+
| Inner product | `\langle \mathbf{x}, \mathbf{y} \rangle` | Linear algebra |
|
|
129
|
+
| Indicator function | `\mathbbm{1}_{[condition]}` | Functions |
|
|
130
|
+
| Summation | `\sum_{i=1}^{N}` | Operations |
|
|
131
|
+
| Product | `\prod_{i=1}^{N}` | Operations |
|
|
132
|
+
| Argmin/argmax | `\operatorname*{argmin}_\theta` | Optimization |
|
|
133
|
+
| KL divergence | `D_\text{KL}(p \| q)` | Information theory |
|
|
134
|
+
|
|
135
|
+
### Custom Operators
|
|
136
|
+
|
|
137
|
+
Define custom operators for clean notation:
|
|
138
|
+
|
|
139
|
+
```latex
|
|
140
|
+
% In preamble
|
|
141
|
+
\DeclareMathOperator*{\argmin}{arg\,min}
|
|
142
|
+
\DeclareMathOperator*{\argmax}{arg\,max}
|
|
143
|
+
\DeclareMathOperator{\Tr}{Tr} % Matrix trace
|
|
144
|
+
\DeclareMathOperator{\diag}{diag} % Diagonal matrix
|
|
145
|
+
\DeclareMathOperator{\softmax}{softmax}
|
|
146
|
+
\DeclareMathOperator{\sigmoid}{\sigma}
|
|
147
|
+
\newcommand{\R}{\mathbb{R}} % Shorthand for real numbers
|
|
148
|
+
\newcommand{\E}{\mathbb{E}} % Shorthand for expectation
|
|
149
|
+
\newcommand{\norm}[1]{\left\| #1 \right\|} % Norm shorthand
|
|
150
|
+
\newcommand{\abs}[1]{\left| #1 \right|} % Absolute value
|
|
151
|
+
\newcommand{\inner}[2]{\langle #1, #2 \rangle} % Inner product
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
## Matrices and Arrays
|
|
155
|
+
|
|
156
|
+
```latex
|
|
157
|
+
% Matrix with parentheses
|
|
158
|
+
\begin{equation}
|
|
159
|
+
\mathbf{W} = \begin{pmatrix}
|
|
160
|
+
w_{11} & w_{12} & \cdots & w_{1n} \\
|
|
161
|
+
w_{21} & w_{22} & \cdots & w_{2n} \\
|
|
162
|
+
\vdots & \vdots & \ddots & \vdots \\
|
|
163
|
+
w_{m1} & w_{m2} & \cdots & w_{mn}
|
|
164
|
+
\end{pmatrix}
|
|
165
|
+
\end{equation}
|
|
166
|
+
|
|
167
|
+
% Matrix with square brackets
|
|
168
|
+
\begin{equation}
|
|
169
|
+
\mathbf{A} = \begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}
|
|
170
|
+
\end{equation}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## Theorems and Proofs
|
|
174
|
+
|
|
175
|
+
```latex
|
|
176
|
+
% In preamble: define theorem environments
|
|
177
|
+
\newtheorem{theorem}{Theorem}[section]
|
|
178
|
+
\newtheorem{lemma}[theorem]{Lemma}
|
|
179
|
+
\newtheorem{proposition}[theorem]{Proposition}
|
|
180
|
+
\newtheorem{corollary}[theorem]{Corollary}
|
|
181
|
+
\theoremstyle{definition}
|
|
182
|
+
\newtheorem{definition}[theorem]{Definition}
|
|
183
|
+
\theoremstyle{remark}
|
|
184
|
+
\newtheorem{remark}[theorem]{Remark}
|
|
185
|
+
|
|
186
|
+
% In document:
|
|
187
|
+
\begin{theorem}[Universal Approximation]
|
|
188
|
+
\label{thm:universal-approx}
|
|
189
|
+
For any continuous function $f: [0,1]^n \to \mathbb{R}$ and any
|
|
190
|
+
$\epsilon > 0$, there exists a feedforward neural network $g$ with
|
|
191
|
+
one hidden layer such that $\sup_{x \in [0,1]^n} |f(x) - g(x)| < \epsilon$.
|
|
192
|
+
\end{theorem}
|
|
193
|
+
|
|
194
|
+
\begin{proof}
|
|
195
|
+
The proof proceeds by construction. Consider a network with
|
|
196
|
+
$\sigmoid$ activation functions...
|
|
197
|
+
|
|
198
|
+
% End proof with QED symbol (automatic with amsthm)
|
|
199
|
+
\end{proof}
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
## Cross-Referencing Best Practices
|
|
203
|
+
|
|
204
|
+
```latex
|
|
205
|
+
% Use cleveref for automatic reference formatting
|
|
206
|
+
\usepackage[capitalise,noabbrev]{cleveref}
|
|
207
|
+
|
|
208
|
+
% Then reference with:
|
|
209
|
+
\cref{eq:loss} % -> "Equation 1"
|
|
210
|
+
\cref{thm:universal-approx} % -> "Theorem 1"
|
|
211
|
+
\Cref{eq:loss} % -> "Equation 1" (capital, for start of sentence)
|
|
212
|
+
\crefrange{eq:loss}{eq:minibatch-loss} % -> "Equations 1 to 3"
|
|
213
|
+
|
|
214
|
+
% Label naming conventions:
|
|
215
|
+
% eq:name for equations
|
|
216
|
+
% thm:name for theorems
|
|
217
|
+
% lem:name for lemmas
|
|
218
|
+
% def:name for definitions
|
|
219
|
+
% fig:name for figures
|
|
220
|
+
% tab:name for tables
|
|
221
|
+
% sec:name for sections
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
## Formatting Tips
|
|
225
|
+
|
|
226
|
+
- Use `\left(` and `\right)` for auto-sizing delimiters, or explicit sizes: `\big(`, `\Big(`, `\bigg(`, `\Bigg(`
|
|
227
|
+
- Use `\text{...}` for words within math mode: `$p(\text{data} | \theta)$`
|
|
228
|
+
- Use `\quad` or `\qquad` for spacing in equations
|
|
229
|
+
- Use `\phantom{x}` for invisible spacing to align elements
|
|
230
|
+
- Avoid `$$...$$` (plain TeX); use `\[...\]` or environments instead
|
|
231
|
+
- Number only equations that are referenced in the text
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: overleaf-collaboration-guide
|
|
3
|
+
description: "Guide to collaborative LaTeX editing with Overleaf"
|
|
4
|
+
metadata:
|
|
5
|
+
openclaw:
|
|
6
|
+
emoji: "team"
|
|
7
|
+
category: "writing"
|
|
8
|
+
subcategory: "latex"
|
|
9
|
+
keywords: ["online LaTeX editor", "collaborative LaTeX", "Overleaf", "LaTeX environment setup"]
|
|
10
|
+
source: "wentor-research-plugins"
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# Overleaf Collaboration Guide
|
|
14
|
+
|
|
15
|
+
Set up and manage collaborative LaTeX projects on Overleaf with best practices for multi-author workflows, version control, and project organization.
|
|
16
|
+
|
|
17
|
+
## Getting Started with Overleaf
|
|
18
|
+
|
|
19
|
+
### Creating a Project
|
|
20
|
+
|
|
21
|
+
Overleaf (overleaf.com) is a browser-based LaTeX editor that provides real-time collaboration, automatic compilation, and integrated version history.
|
|
22
|
+
|
|
23
|
+
Project creation options:
|
|
24
|
+
|
|
25
|
+
| Method | When to Use |
|
|
26
|
+
|--------|-------------|
|
|
27
|
+
| Blank project | Starting from scratch |
|
|
28
|
+
| Upload project | Migrating existing local LaTeX project |
|
|
29
|
+
| Import from GitHub | Existing repo-based project |
|
|
30
|
+
| Use a template | Conference/journal submissions (IEEE, ACM, Springer, Elsevier templates available) |
|
|
31
|
+
| Copy from existing | Forking a previous project |
|
|
32
|
+
|
|
33
|
+
### Recommended Project Structure
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
project-root/
|
|
37
|
+
├── main.tex # Main document (entry point)
|
|
38
|
+
├── preamble.tex # Packages, macros, custom commands
|
|
39
|
+
├── sections/
|
|
40
|
+
│ ├── 01-introduction.tex
|
|
41
|
+
│ ├── 02-related-work.tex
|
|
42
|
+
│ ├── 03-methods.tex
|
|
43
|
+
│ ├── 04-results.tex
|
|
44
|
+
│ ├── 05-discussion.tex
|
|
45
|
+
│ └── 06-conclusion.tex
|
|
46
|
+
├── figures/
|
|
47
|
+
│ ├── fig1-overview.pdf
|
|
48
|
+
│ ├── fig2-results.pdf
|
|
49
|
+
│ └── fig3-comparison.pdf
|
|
50
|
+
├── tables/
|
|
51
|
+
│ └── results-table.tex
|
|
52
|
+
├── references.bib # Bibliography database
|
|
53
|
+
└── README.md # Project notes (not compiled)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Main File Setup
|
|
57
|
+
|
|
58
|
+
```latex
|
|
59
|
+
% main.tex
|
|
60
|
+
\documentclass[conference]{IEEEtran} % or article, etc.
|
|
61
|
+
\input{preamble} % load packages and macros
|
|
62
|
+
|
|
63
|
+
\begin{document}
|
|
64
|
+
|
|
65
|
+
\title{Your Paper Title}
|
|
66
|
+
\author{Author One \and Author Two \and Author Three}
|
|
67
|
+
\maketitle
|
|
68
|
+
|
|
69
|
+
\begin{abstract}
|
|
70
|
+
Your abstract here.
|
|
71
|
+
\end{abstract}
|
|
72
|
+
|
|
73
|
+
\input{sections/01-introduction}
|
|
74
|
+
\input{sections/02-related-work}
|
|
75
|
+
\input{sections/03-methods}
|
|
76
|
+
\input{sections/04-results}
|
|
77
|
+
\input{sections/05-discussion}
|
|
78
|
+
\input{sections/06-conclusion}
|
|
79
|
+
|
|
80
|
+
\bibliographystyle{IEEEtran}
|
|
81
|
+
\bibliography{references}
|
|
82
|
+
|
|
83
|
+
\end{document}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Multi-Author Collaboration
|
|
87
|
+
|
|
88
|
+
### Sharing and Permissions
|
|
89
|
+
|
|
90
|
+
| Role | Capabilities |
|
|
91
|
+
|------|-------------|
|
|
92
|
+
| Owner | Full control, can delete project, manage collaborators |
|
|
93
|
+
| Editor | Can edit all files, cannot manage collaborators |
|
|
94
|
+
| Viewer | Read-only access, can download but not modify |
|
|
95
|
+
|
|
96
|
+
Share via:
|
|
97
|
+
- **Link sharing**: Generate a read-only or edit link (anyone with the link can access)
|
|
98
|
+
- **Email invitation**: Invite specific collaborators by email with role assignment
|
|
99
|
+
|
|
100
|
+
### Author Coordination Best Practices
|
|
101
|
+
|
|
102
|
+
1. **Assign sections**: Each author owns specific `.tex` files to minimize merge conflicts.
|
|
103
|
+
2. **Use comments**: Overleaf supports inline comments (`% TODO: revise this paragraph`) and threaded review comments.
|
|
104
|
+
3. **Use custom commands for notes**:
|
|
105
|
+
|
|
106
|
+
```latex
|
|
107
|
+
% In preamble.tex, define author-specific annotation commands
|
|
108
|
+
\usepackage{xcolor}
|
|
109
|
+
\newcommand{\alice}[1]{\textcolor{blue}{[Alice: #1]}}
|
|
110
|
+
\newcommand{\bob}[1]{\textcolor{red}{[Bob: #1]}}
|
|
111
|
+
\newcommand{\todo}[1]{\textcolor{orange}{[TODO: #1]}}
|
|
112
|
+
|
|
113
|
+
% In text:
|
|
114
|
+
This result is surprising \alice{Should we add more analysis here?}
|
|
115
|
+
and warrants further investigation \todo{Add statistical test}.
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
4. **Track changes**: Overleaf Premium includes a track-changes mode. For free plans, use the `changes` package:
|
|
119
|
+
|
|
120
|
+
```latex
|
|
121
|
+
\usepackage{changes}
|
|
122
|
+
\definechangesauthor[name={Alice}, color=blue]{AL}
|
|
123
|
+
\definechangesauthor[name={Bob}, color=red]{BO}
|
|
124
|
+
|
|
125
|
+
% Usage:
|
|
126
|
+
\added[id=AL]{This is new text added by Alice.}
|
|
127
|
+
\deleted[id=BO]{This text was removed by Bob.}
|
|
128
|
+
\replaced[id=AL]{new text}{old text}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Git Integration
|
|
132
|
+
|
|
133
|
+
### Overleaf + GitHub Sync
|
|
134
|
+
|
|
135
|
+
Overleaf Premium supports bidirectional GitHub sync:
|
|
136
|
+
|
|
137
|
+
1. In Overleaf, go to Menu > Sync > GitHub
|
|
138
|
+
2. Link your GitHub account and select or create a repository
|
|
139
|
+
3. Pull/push changes between Overleaf and GitHub
|
|
140
|
+
|
|
141
|
+
### Overleaf + Local Git
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
# Clone your Overleaf project via git
|
|
145
|
+
git clone https://git.overleaf.com/YOUR_PROJECT_ID my-paper
|
|
146
|
+
cd my-paper
|
|
147
|
+
|
|
148
|
+
# Edit locally, then push back to Overleaf
|
|
149
|
+
git add -A
|
|
150
|
+
git commit -m "Updated results table"
|
|
151
|
+
git push origin master
|
|
152
|
+
|
|
153
|
+
# Pull changes made on Overleaf
|
|
154
|
+
git pull origin master
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
**Credentials**: Use your Overleaf email as username and an Overleaf-generated token as password.
|
|
158
|
+
|
|
159
|
+
## Compilation and Debugging
|
|
160
|
+
|
|
161
|
+
### Common Compilation Errors
|
|
162
|
+
|
|
163
|
+
| Error | Cause | Fix |
|
|
164
|
+
|-------|-------|-----|
|
|
165
|
+
| `Undefined control sequence` | Missing package or typo in command | Check `\usepackage` or spelling |
|
|
166
|
+
| `Missing $ inserted` | Math symbol outside math mode | Wrap in `$...$` or `\text{...}` |
|
|
167
|
+
| `File not found` | Incorrect path in `\input` or `\includegraphics` | Check file names (case-sensitive on Overleaf) |
|
|
168
|
+
| `Overfull \hbox` | Content too wide for column | Resize figure, adjust text, or add `\sloppy` |
|
|
169
|
+
| `Citation undefined` | BibTeX entry missing or key mismatch | Verify `.bib` entry key matches `\cite{}` |
|
|
170
|
+
|
|
171
|
+
### Debugging Tips
|
|
172
|
+
|
|
173
|
+
- Use **Recompile from scratch** (Ctrl+Shift+Enter) to clear cache
|
|
174
|
+
- Check the **Logs and output files** panel for detailed error messages
|
|
175
|
+
- Use `\listfiles` in preamble to see which packages are loaded
|
|
176
|
+
- Overleaf uses TeX Live 2024; check package compatibility if using older templates
|
|
177
|
+
|
|
178
|
+
## Submission Workflow
|
|
179
|
+
|
|
180
|
+
### Preparing for Journal Submission
|
|
181
|
+
|
|
182
|
+
1. **Flatten the project**: Some journals require a single `.tex` file.
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
# Use latexpand to flatten \input commands
|
|
186
|
+
latexpand main.tex > submission.tex
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
2. **Check formatting**: Verify page limits, font sizes, margin requirements.
|
|
190
|
+
3. **Download as zip**: Menu > Download > Source to get all files.
|
|
191
|
+
4. **Convert figures**: Ensure all figures are in accepted formats (PDF, EPS, or high-res PNG/TIFF).
|
|
192
|
+
5. **Clean up**: Remove TODO comments, author annotation commands, and debug code.
|
|
193
|
+
|
|
194
|
+
```latex
|
|
195
|
+
% Add to preamble for submission: disable all annotation commands
|
|
196
|
+
\renewcommand{\alice}[1]{}
|
|
197
|
+
\renewcommand{\bob}[1]{}
|
|
198
|
+
\renewcommand{\todo}[1]{}
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Useful Overleaf Keyboard Shortcuts
|
|
202
|
+
|
|
203
|
+
| Action | Shortcut (Mac) | Shortcut (Windows) |
|
|
204
|
+
|--------|---------------|-------------------|
|
|
205
|
+
| Compile | Cmd+Enter | Ctrl+Enter |
|
|
206
|
+
| Bold | Cmd+B | Ctrl+B |
|
|
207
|
+
| Italic | Cmd+I | Ctrl+I |
|
|
208
|
+
| Comment toggle | Cmd+/ | Ctrl+/ |
|
|
209
|
+
| Find & replace | Cmd+H | Ctrl+H |
|
|
210
|
+
| Go to line | Cmd+Shift+L | Ctrl+Shift+L |
|
|
211
|
+
| Toggle PDF | Cmd+Shift+O | Ctrl+Shift+O |
|