Skip to content

Commit e932f8c

Browse files
committed
Refine CLI documentation wording
1 parent 82352e7 commit e932f8c

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
## [2.8] - 2026-03-08
66
### 변경
77
- `HwpxPackage`와 OXML 로딩/저장이 rootfile/manifest-relative 경로를 실제로 따르도록 정렬했습니다.
8-
- `hwpx-analyze-template --extract-dir`pack-ready 작업 디렉터리와 `.hwpx-pack-metadata.json`을 생성하도록 확장했습니다.
8+
- `hwpx-analyze-template --extract-dir`재구성에 바로 쓸 수 있는 작업 디렉터리와 `.hwpx-pack-metadata.json`을 생성하도록 확장했습니다.
99
- `hwpx-validate-package`를 엔진 정합 기준으로 재작성해 dynamic rootfile/manifest 관계, CRC, fallback warning을 구분하도록 했습니다.
1010
- `hwpx-unpack` 기본값을 raw-byte preserving으로 바꾸고 `--pretty-xml` opt-in을 추가했습니다.
1111
- tooling/OPC 회귀 테스트를 확대하고, coverage threshold를 60으로 올렸으며, pyright는 touched OPC/tooling 범위에서 `basic`으로 상향했습니다.
@@ -23,7 +23,7 @@
2323

2424
### 변경
2525
- `scripts/office/unpack.py`, `scripts/office/pack.py`, `scripts/analyze_template.py`를 패키지 도구 래퍼로 정리했습니다.
26-
- `page_guard`에 shape/control count 및 히스토그램 비교를 추가하고, rendered page count가 아닌 layout-drift proxy임을 문서와 CLI 설명에 명시했습니다.
26+
- `page_guard`에 shape/control count 및 히스토그램 비교를 추가하고, 실제 페이지 수 계산기가 아니라 구조 변화 징후 점검 도구임을 문서와 CLI 설명에 명시했습니다.
2727
- README와 `docs/usage.md`에 새 CLI 사용 예시를 추가했습니다.
2828
- 새 tooling에 대한 CLI/추출/overwrite/page-guard 회귀 테스트를 강화했습니다.
2929

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ doc.save_to_path("결과물.hwpx")
9999
| 🎨 **스타일 치환** | 서식 기반 필터 | 색상/밑줄/charPrIDRef 기반 Run 검색 및 교체 |
100100
| 📤 **내보내기** | 텍스트/HTML/Markdown | 문서 변환 출력 |
101101
|**유효성 검사** | XSD + 패키지 구조 | CLI(`hwpx-validate`, `hwpx-validate-package`) 및 API |
102-
| 🧰 **워크플로 도구** | unpack/pack/template analyze/page guard | 템플릿 보존형 XML-first 작업 보조 |
102+
| 🧰 **작업 도구** | unpack/pack/분석/비교 | 패키지 점검과 재구성 작업 보조 |
103103
| 🏗️ **저수준 XML** | 데이터클래스 매핑 | OWPML 스키마 ↔ Python 객체 직접 조작 |
104104
| 🔄 **네임스페이스 호환** | 자동 정규화 | HWPML 20162011 자동 변환 |
105105
@@ -203,7 +203,7 @@ python-hwpx
203203
│ ├── exporter # 텍스트/HTML/Markdown 내보내기
204204
│ ├── validator # 스키마 유효성 검사 (hwpx-validate CLI)
205205
│ ├── package_validator# ZIP/OPC/HWPX 구조 검사
206-
│ ├── page_guard # layout-drift proxy
206+
│ ├── page_guard # 구조 변화 징후 점검
207207
│ └── template_analyzer# 레퍼런스 문서 분석/추출
208208
└── hwpx.templates # 내장 빈 문서 템플릿
209209
```
@@ -222,23 +222,23 @@ hwpx-unpack 문서.hwpx ./unpacked
222222
hwpx-unpack 문서.hwpx ./pretty-unpacked --pretty-xml
223223
hwpx-pack ./unpacked ./repacked.hwpx
224224

225-
# 레퍼런스 템플릿 분석과 pack-ready 추출
225+
# 레퍼런스 문서 분석과 작업 디렉터리 추출
226226
hwpx-analyze-template 문서.hwpx --extract-dir ./template-parts --json
227227
hwpx-pack ./template-parts ./template-roundtrip.hwpx
228228
hwpx-validate-package ./template-roundtrip.hwpx
229229

230230
# plain / markdown 텍스트 추출
231231
hwpx-text-extract 문서.hwpx --format markdown --output 문서.md
232232

233-
# 레이아웃 드리프트 프록시 비교
233+
# 문서 구조 변화 징후 비교
234234
hwpx-page-guard --reference 원본.hwpx --output 결과.hwpx
235235
```
236236

237-
`hwpx-page-guard`는 렌더된 실제 쪽수를 계산하지 않습니다. 대신 단락 수, 표 수, shape/control 수, 명시적 page/column break, 텍스트 길이 통계를 비교해 레이아웃 드리프트 위험을 탐지하는 프록시 도구입니다.
237+
`hwpx-page-guard`는 렌더된 실제 쪽수를 계산하지 않습니다. 대신 단락 수, 표 수, shape/control 수, 명시적 page/column break, 텍스트 길이 같은 구조 지표를 비교해 편집 전후 변화 징후를 빠르게 점검합니다.
238238

239-
`hwpx-validate-package``Contents/content.hpf` 같은 고정 경로를 강제하지 않고, `META-INF/container.xml`선택된 rootfile/manifest 관계를 따라가며 검사합니다. 엔진이 fallback으로 열 수 있는 비표준 패키지는 가능한 경우 경고로 구분합니다.
239+
`hwpx-validate-package``Contents/content.hpf` 같은 고정 경로를 전제로 두지 않고, `META-INF/container.xml`실제 rootfile/manifest 선언을 따라가며 패키지 구조를 확인합니다. 엔진이 열 수 있는 비표준 패키지는 가능한 경우 경고로 분리해 보여줍니다.
240240

241-
`hwpx-analyze-template --extract-dir`covered fixture 기준으로 `hwpx-pack``hwpx-validate-package`, 그리고 엔진 open 경로에 다시 투입할 수 있는 pack-ready 작업 디렉터리를 만듭니다. 이건 재패킹 가능성을 목표로 한 것이지, 렌더링 fidelity를 보장한다는 뜻은 아닙니다.
241+
`hwpx-analyze-template --extract-dir`는 다시 묶고 점검하기 쉬운 작업 디렉터리를 만듭니다. 재구성과 구조 검증에 필요한 파일을 함께 꺼내는 용도이며, 편집기에서의 최종 렌더링 결과까지 보장한다는 뜻은 아닙니다.
242242

243243
## 문서
244244

docs/usage.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,23 @@ hwpx-unpack sample.hwpx ./sample-unpacked
1515
hwpx-unpack sample.hwpx ./sample-pretty --pretty-xml
1616
hwpx-pack ./sample-unpacked ./sample-repacked.hwpx
1717

18-
# 템플릿 분석과 pack-ready 작업 디렉터리 추출
18+
# 템플릿 분석과 작업 디렉터리 추출
1919
hwpx-analyze-template sample.hwpx --extract-dir ./template-parts --json
2020
hwpx-pack ./template-parts ./template-roundtrip.hwpx
2121
hwpx-validate-package ./template-roundtrip.hwpx
2222

2323
# 텍스트 추출
2424
hwpx-text-extract sample.hwpx --format markdown --output sample.md
2525

26-
# 레이아웃 드리프트 프록시
26+
# 문서 구조 변화 징후 점검
2727
hwpx-page-guard --reference sample.hwpx --output edited.hwpx
2828
```
2929

30-
`hwpx-page-guard`는 실제 렌더러의 쪽수를 계산하지 않고, 구조 및 텍스트 통계를 비교해 레이아웃 변화 위험을 탐지하는 프록시 검사기입니다.
30+
`hwpx-page-guard`는 실제 렌더러의 쪽수를 계산하지 않고, 구조 및 텍스트 통계를 비교해 편집 전후 변화 징후를 점검하는 도구입니다.
3131

32-
`hwpx-validate-package`는 고정 기본 경로를 가정하지 않고 `container.xml`과 rootfile/manifest 관계를 따라가며 검사합니다. 엔진이 fallback으로 열 수 있는 비표준 패키지는 에러 대신 경고로 분리할 수 있습니다.
32+
`hwpx-validate-package`는 고정 기본 경로를 전제로 두지 않고 `container.xml`실제 rootfile/manifest 관계를 따라가며 검사합니다. 엔진이 열 수 있는 비표준 패키지는 에러 대신 경고로 분리해 볼 수 있습니다.
3333

34-
`hwpx-analyze-template --extract-dir``mimetype`, `META-INF/container.xml`, rootfile, manifest-related parts, 중요 자산, `.hwpx-pack-metadata.json`을 포함한 pack-ready 작업 디렉터리를 만듭니다. covered fixture 기준으로 재패킹/재검증 가능한 범위를 목표로 하며, 렌더링 fidelity를 보장하지는 않습니다.
34+
`hwpx-analyze-template --extract-dir``mimetype`, `META-INF/container.xml`, rootfile, manifest 관련 파일, 중요 자산, `.hwpx-pack-metadata.json`을 포함한 작업 디렉터리를 만듭니다. 다시 묶고 구조를 점검하는 흐름을 돕기 위한 것이며, 렌더링 결과까지 보장하지는 않습니다.
3535

3636
## 빠른 예제 모음
3737

0 commit comments

Comments
 (0)