jedarden/pdftract
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(pdftract-2bpzs): add verification note for OutputOptions implementation

Browse source 
The OutputOptions struct with block-kind filtering and CLI flags
was already implemented in the codebase. All 8 acceptance criteria
tests pass.

- Struct defined in pdftract-core/src/options.rs
- CLI flags wired in pdftract-cli/src/main.rs
- Tests: default values, block kind filtering, span filtering

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
jedarden 2026-05-28 00:52:30 -04:00
parent 3d8dc58541
commit 6f86258a7a
1 changed files with 65 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
notes/pdftract-2bpzs.md Normal file
View file

@ -0,0 +1,65 @@
# pdftract-2bpzs: OutputOptions struct + block-kind filter
## Summary
The `OutputOptions` struct with block-kind filtering and CLI flags was already implemented in the codebase. This note verifies the implementation meets all acceptance criteria.
## Implementation Location
- **Struct definition**: `/home/coding/pdftract/crates/pdftract-core/src/options.rs` (lines 69-185)
- **CLI integration**: `/home/coding/pdftract/crates/pdftract-cli/src/main.rs` (lines 149-171 for flags, 755-760 for wiring)
## Acceptance Criteria Status
| Criteria | Status | Evidence |
|----------|--------|----------|
| Default OutputOptions: all include_* false | PASS | `test_output_options_default` passes |
| --include-headers-footers sets both true | PASS | `test_output_options_include_headers_and_footers` passes |
| --include-invisible-text: include_invisible true | PASS | CLI flag wired correctly (line 758) |
| Filter rejects Header when include_headers false | PASS | `test_output_options_include_block_kind` passes |
| Filter accepts Header when include_headers true | PASS | `test_output_options_include_block_kind_with_flags` passes |
| Watermark filtering ready for Phase 7 | PASS | `include_block_kind("watermark")` implemented |
## Struct Definition
```rust
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
#[serde(default)]
pub struct OutputOptions {
pub include_headers: bool,
pub include_footers: bool,
pub include_watermarks: bool,
pub include_invisible: bool,
pub include_hidden_layers: bool,
pub include_struct_metadata: bool,
}
```
## CLI Flags
- `--include-headers` - Include header blocks
- `--include-footers` - Include footer blocks
- `--include-headers-footers` - Include both headers and footers
- `--include-invisible-text` - Include invisible text spans (rendering_mode == 3)
- `--include-hidden-layers` - Include hidden-layer text spans (OCG-controlled)
- `--include-watermarks` - Include watermark blocks (no-op until Phase 7)
## Test Results
All 8 OutputOptions tests pass:
```
test options::tests::test_output_options_default ... ok
test options::tests::test_output_options_deserialize ... ok
test options::tests::test_output_options_include_block_kind ... ok
test options::tests::test_output_options_include_block_kind_with_flags ... ok
test options::tests::test_output_options_include_headers_and_footers ... ok
test options::tests::test_output_options_include_span ... ok
test options::tests::test_output_options_include_span_with_flags ... ok
test options::tests::test_output_options_serialize ... ok
```
## Conclusion
The implementation is complete and all acceptance criteria pass. The feature is ready for use.