# ppt-commitment-parser

> 將施政報告或施政綱要轉換成 CSV 的工具。

Latest version **0.0.2** (published 2015-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install ppt-commitment-parser
pnpm add ppt-commitment-parser
yarn add ppt-commitment-parser
bun add ppt-commitment-parser
```

Provides the command `commitment-parser`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2015-07-17 |
| First published | 2015-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | MrOrz |
| Maintainers | mrorz |
| Keywords | pdftotext |

## Links

- npm: https://www.npmjs.com/package/ppt-commitment-parser
- Repository: https://github.com/g0v/ppt-commitment-parser
- Issues: https://github.com/g0v/ppt-commitment-parser/issues
- npm.io page: https://npm.io/package/ppt-commitment-parser

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [yargs](https://npm.io/package/yargs.md) ^3.15.0
- [zhutil](https://npm.io/package/zhutil.md) git://github.com/MrOrz/npm-zhutil#deploy
- [pdftojson](https://npm.io/package/pdftojson.md) 0.0.2
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^5.6.15
- [csv-stringify](https://npm.io/package/csv-stringify.md) 0.0.8
- [es6-promisify](https://npm.io/package/es6-promisify.md) ^2.0.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2015-07-17
- 0.0.1 — 2015-07-13

## README

ppt-commitment-parser
=====================

[![Build Status](https://travis-ci.org/g0v/ppt-commitment-parser.svg)](https://travis-ci.org/g0v/ppt-commitment-parser) [![Coverage Status](https://coveralls.io/repos/g0v/ppt-commitment-parser/badge.svg?branch=master&service=github)](https://coveralls.io/github/g0v/ppt-commitment-parser?branch=master)

將施政報告或施政綱要 PDF 轉換成 CSV 的工具。
PDF 檔必須要用公文書格式進行標號（階層依序為「壹、」「一、」「(一)」「1、」「(1)」「甲、 或 Ａ.」，系統會處理半型全型的差異），方能處理。

Usage
-----

### CLI

```
$ commitment-parser <options> PDF檔名
```

範例與說明都寫在 `ppt-parser --help`。

### Library

```js
import pdftojson from 'pdftojson';
import parser from 'ppt-commitment-parser';

pdftojson(PDF路徑).then(pdfData => {
  var parsedData = parser(pdfData, parserOption);
  // parsedData 格式請見下「陣列輸出」
})
```


Output Format
-------------

### 輸入 PDF 範例

以[桃園市議會第 1 屆第 1 次定期會的市長施政報告](http://www.tycg.gov.tw/ch/home.jsp?id=20&parentpath=0,4&mcustomize=policy_list.jsp&qclass=201205290001)第 14 頁的某段文字為例：

![PDF](http://i.imgur.com/mX1pdHQ.png)

### CSV 輸出（CLI）

```csv
# 前 6 個固定是分層，第 7 個是頁碼，第 8、9 是左上點 x、y 坐標（pt），第 10 個是內文
# 坐標為最小的標題的坐標，以頁面左下角為原點。。
"政策規劃與執行","捷運城市","發展無縫公共運輸","推動捷運建設","","",14,80,454,"為配合//⋯⋯"
"政策規劃與執行","捷運城市","發展無縫公共運輸","推動捷運建設","航空城捷運線(綠線)","",14,109,556,"航空城捷運線(綠線)總長約//⋯⋯"
# ...
```

### Array 輸出（Library）

```js
[
  {
    number: 2,
    numberCH: '貳',
    text: '政策規劃與執行',
    page: 14,
    coord: [55, 373], // 頁面左下點為原點，單位：pt
    items: [
      {
        number: 1,
        numberCH: '一',
        text: "捷運城市",
        page: 14,
        coord: [55, 402],
        items: [
          {
            number: 1,
            numberCH: '(一)',
            text: '發展無縫公共運輸',
            page: 14,
            coord: [62, 427],
            items: [
              {
                number: 1,
                numberCH: '1',
                text: '推動捷運建設',
                page: 14,
                coord: [80, 454],
                items: [
                  // text-only
                  {
                    text: '為配合航空城發展/* ⋯⋯ */及優質適居的低碳生態環境。',
                    page: 14,
                    coord: [132, 480]
                  },
                  { // text with number
                    number: 1,
                    numberCH: '(1)',
                    text: '航空城捷運線(綠線)',
                    page: 14,
                    coord: [109, 556]
                    items: [ /* ... */ ]
                  }, // ...
                ]
              }
            ]
          }, //...
        ]
      }, //...
    ]
  }, // ...
]
```

Error Handling
--------------

```js
pdftojson(PDF路徑, {onError: (errType, errPayload) => {}}) // returns a promise
```

`onError` callback 的 `this` 會被設成 `LineMachine` instance，因此可以存取 `LineMachine` 的 method （請見 [`LineMachine` 的實作](https://github.com/g0v/ppt-commitment-parser/blob/master/src/lineMachine.js)）。

### `errType === 'PARSE_NUM'`

```js
errPayload === {
  input // 中文數字
}
```

`errPayload.input` 無法被轉為數字。

### `errType === 'NUMBER_MISMATCH'`

```js
errPayload === {
  text, // 出錯的該行文字
  page, // 出錯文字所在頁碼
  number, // 出錯文字的標號（已轉數字）
  lastSiblingSection, // 同層前一 Section instance（若出錯的是該層第一項，則為 undefined）
}
```

各層標題應該要從 1 開始而且連續，若有數字不連續的狀況，就會觸發此 error。

### `errType === 'LEVEL_MISMATCH'`

```js
errPayload === {
  text, // 出錯的該行文字
  page, // 出錯文字所在頁碼
  coord, // 出錯文字所在頁面坐標（左下為原點，單位 pt）
  level, // 標題層級（-1 為頂層，0 為「壹、」，6 為「甲、」）
  lastLevel, // 前文標題層級
  numberCH // 出錯文字的標號
}
```

`errPayload.text` 的標題階層與所在之前文不符。

標題階層應依序為「壹、」、「一、」、「（一）」、「1、」、「（1）」、「甲、」六層。
若某一行突然向下太多層（例如說原本在「一、」，突然有一行用「1、」標號），就會觸發此 error。

---
_Source: https://npm.io/package/ppt-commitment-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._