Skip to content

out_file: add description about file format #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2017
Merged

out_file: add description about file format #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions output/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,30 @@ The plugin supports the following configuration parameters:
| Key | Description |
|------|-------------|
| Path | File path to output. If not set, the filename will be tag name.|
| Format | The format of the file content. See also Format section. Default: out_file.|

## Format

### out_file format

Output time, tag and json records. There is no configuration parameters for out_file.

```json
tag: [time, {"key1":"value1", "key2":"value2", "key3":"value3"}]
```

### csv format

Output the records as csv. Csv supports an additional configuration parameter.

| Key | Description |
|------|-------------|
| Delimiter | The character to separate each data. Default: ','|


```python
time[delimiter]"value1"[delimiter]"value2"[delimiter]"value3"
```

## Getting Started

Expand Down