docrev 0.2.0 → 0.3.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/CLAUDE.md +2 -2
- package/README.md +35 -2
- package/bin/rev.js +696 -5
- package/lib/build.js +10 -2
- package/lib/crossref.js +138 -49
- package/lib/equations.js +235 -0
- package/lib/git.js +238 -0
- package/lib/journals.js +420 -0
- package/lib/merge.js +365 -0
- package/lib/trackchanges.js +273 -0
- package/lib/word.js +225 -0
- package/package.json +7 -5
package/CLAUDE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Claude Instructions for
|
|
1
|
+
# Claude Instructions for docrev
|
|
2
2
|
|
|
3
|
-
This is `rev
|
|
3
|
+
This is `docrev` (command: `rev`), a CLI tool for academic paper workflows with Word ↔ Markdown round-trips.
|
|
4
4
|
|
|
5
5
|
## Key Commands for Claude
|
|
6
6
|
|
package/README.md
CHANGED
|
@@ -41,9 +41,12 @@ rev install # Check for missing dependencies
|
|
|
41
41
|
- **Import from Word** - Diff Word docs against your Markdown, generating CriticMarkup annotations
|
|
42
42
|
- **Section-aware import** - Import directly to modular section files (intro.md, methods.md, etc.)
|
|
43
43
|
- **Interactive review** - Accept/reject track changes with a TUI
|
|
44
|
-
- **Comment management** - List and
|
|
44
|
+
- **Comment management** - List, filter, resolve, and reply to reviewer comments
|
|
45
|
+
- **Response letter generation** - Auto-generate point-by-point response from comments
|
|
45
46
|
- **DOI validation** - Check and find DOIs via Crossref/DataCite APIs
|
|
46
|
-
- **Cross-reference conversion** - Auto-convert
|
|
47
|
+
- **Cross-reference conversion** - Auto-convert "Figures 1-3" to `@fig:label` syntax (handles complex patterns)
|
|
48
|
+
- **Equation extraction** - Extract LaTeX equations from Word documents (OMML → LaTeX)
|
|
49
|
+
- **Citation validation** - Check citations against bibliography
|
|
47
50
|
|
|
48
51
|
## Quick Start
|
|
49
52
|
|
|
@@ -114,6 +117,8 @@ rev build docx
|
|
|
114
117
|
| Command | Description |
|
|
115
118
|
|---------|-------------|
|
|
116
119
|
| `rev build [formats...]` | Build PDF/DOCX/TEX from sections |
|
|
120
|
+
| `rev build --toc` | Build with table of contents |
|
|
121
|
+
| `rev build --show-changes` | Export DOCX with visible track changes |
|
|
117
122
|
| `rev new <name>` | Create new project from template |
|
|
118
123
|
| `rev new --list` | List available templates |
|
|
119
124
|
| `rev install` | Check/install dependencies (pandoc-crossref) |
|
|
@@ -134,6 +139,8 @@ rev build docx
|
|
|
134
139
|
| `rev review <file>` | Interactive accept/reject TUI for track changes |
|
|
135
140
|
| `rev status <file>` | Show annotation counts |
|
|
136
141
|
| `rev comments <file>` | List all comments with context |
|
|
142
|
+
| `rev comments <file> --export comments.csv` | Export comments to CSV |
|
|
143
|
+
| `rev resolve <file> -n 1` | Mark comment #1 as resolved |
|
|
137
144
|
| `rev strip <file>` | Output clean Markdown (annotations applied) |
|
|
138
145
|
|
|
139
146
|
### Cross-References
|
|
@@ -160,6 +167,27 @@ rev build docx
|
|
|
160
167
|
| `rev doi fetch <doi>` | Fetch BibTeX entry from DOI |
|
|
161
168
|
| `rev doi add <doi>` | Fetch and add DOI entry to bibliography |
|
|
162
169
|
|
|
170
|
+
### Validation & Analysis
|
|
171
|
+
|
|
172
|
+
| Command | Description |
|
|
173
|
+
|---------|-------------|
|
|
174
|
+
| `rev citations [file.bib]` | Validate citations against bibliography |
|
|
175
|
+
| `rev figures [file]` | List figures/tables with reference counts |
|
|
176
|
+
| `rev equations list` | List all equations in section files |
|
|
177
|
+
| `rev equations from-word <docx>` | Extract equations from Word to LaTeX |
|
|
178
|
+
| `rev response [files]` | Generate response letter from comments |
|
|
179
|
+
| `rev anonymize <file>` | Prepare document for blind review |
|
|
180
|
+
| `rev validate --journal <name>` | Check manuscript against journal requirements |
|
|
181
|
+
| `rev validate --list` | List available journal profiles |
|
|
182
|
+
|
|
183
|
+
### Multi-Reviewer & Git
|
|
184
|
+
|
|
185
|
+
| Command | Description |
|
|
186
|
+
|---------|-------------|
|
|
187
|
+
| `rev merge <md> <docx...>` | Merge feedback from multiple Word documents |
|
|
188
|
+
| `rev diff [ref]` | Compare sections against git history |
|
|
189
|
+
| `rev history [file]` | Show revision history for sections |
|
|
190
|
+
|
|
163
191
|
### Configuration
|
|
164
192
|
|
|
165
193
|
| Command | Description |
|
|
@@ -215,10 +243,12 @@ pdf:
|
|
|
215
243
|
fontsize: 12pt
|
|
216
244
|
geometry: margin=1in
|
|
217
245
|
linestretch: 1.5
|
|
246
|
+
toc: false # Table of contents
|
|
218
247
|
|
|
219
248
|
docx:
|
|
220
249
|
reference: template.docx # Optional reference doc
|
|
221
250
|
keepComments: true
|
|
251
|
+
toc: false # Table of contents
|
|
222
252
|
```
|
|
223
253
|
|
|
224
254
|
## Annotation Syntax (CriticMarkup)
|
|
@@ -266,6 +296,9 @@ When importing from Word, hardcoded refs are auto-converted:
|
|
|
266
296
|
- `Figure 1` → `@fig:heatmap`
|
|
267
297
|
- `Fig. 2a` → `@fig:model`
|
|
268
298
|
- `Figs. 1-3` → `@fig:heatmap; @fig:model; @fig:hierarchy`
|
|
299
|
+
- `Figures 1, 2, and 3` → `@fig:one; @fig:two; @fig:three`
|
|
300
|
+
- `Fig. 1a-c` → `@fig:one` (expands letter suffixes)
|
|
301
|
+
- `Figs. 1a-3b` → all panels from 1a to 3b
|
|
269
302
|
|
|
270
303
|
## Build Outputs
|
|
271
304
|
|