Skip to content

Commit f82cd22

Browse files
committed
updated readme according to new features
1 parent 48255d3 commit f82cd22

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ My plugin allows you to configure a few things in its settings:
1818

1919
This is the first part of the filename of the CSV file you're about to save.
2020

21-
Default: `table-export`
21+
**Default**: `table-export`
2222

2323
* A file number addition
2424

@@ -29,25 +29,31 @@ My plugin allows you to configure a few things in its settings:
2929
It may become neccessary to either change this number manually or to delete/rename/move files out of your vault folder.
3030
No worries, though: the plugin never overwrites any files and warns you if a file already exists.
3131

32-
Default: `001`
32+
**Default**: `001`
3333

3434
* The separation character
3535

36-
Here you can change the character that separates the data fields in the CSV file. You can enter more than one character here, too, if you like. Entering a TAB character (as `\t` or otherwise) is currently not possible. But you might have the need to change the default comma to a semicolon if your data contains commas.
36+
Here you can select the character that separates the data fields in the CSV file. The dropdown box contains the usual suspects like comma, semicolon and tab. But there are some unusual choices as well.
3737

38-
Default: `,`
38+
**Default**: `;`
3939

4040
* Quote data
4141

42-
Switch this on if you want the data cells in the CSV file to be enclosed in double quote marks. Currently, you can't change that quote character. It's `"` for now.
42+
If you want the data cells in the CSV file to be enclosed in quotation marks you can choose to do so here. In the dropdown box you can choose between either double quotation marks (`"`), single quotation marks (`'`) or not to quote data at all.
4343

44-
Default: `off`
44+
**Default**: no quoting
45+
46+
* Handling of CR/LF in data
47+
48+
In some rare cases you might have return (CR) or linefeed (LF) characters inside of data fields/cells. This will break the CSV file. With this setting you can select how you want to handle these characters. You can either simply strip them, replace them with a single space character or replace them with the fixed string `[CR]`so that you later can still see that there once _was_ some kind of return character in your data.
49+
50+
**Default**: Replace all CR & LF characters with one space
4551

4652
* Copy to clipboard, too
4753

4854
Optionally you can copy the CSV string to the clipboard, too.
4955

50-
Default: `off`
56+
**Default**: `off`
5157

5258
## Usage
5359

@@ -57,12 +63,10 @@ The plugin works on mobile, too. (Tested on iPadOS only, though.)
5763

5864
## Current limitations
5965

60-
Of course, there's always room for improvement. **Currently, there are the following limitations/restrictions**:
66+
Of course, there's always room for improvement. **As of version 0.1.4, there are the following limitations/restrictions**:
6167

6268
* The plugin currently exports only the first table that it finds in the reading mode of a note.
6369
* The plugin saves the CSV file directly into you vault's main folder. A feature to select another folder inside your vault will be added later.
64-
* It's currently not possible to use a TAB character as a separation character.
65-
* The quotation character is currently the double quote character `"` and cannot be changed.
6670

6771
## Thanks
6872

@@ -76,3 +80,9 @@ I'd like to thank several people here. Without them this plugin wouldn't have co
7680

7781
Please leave feedback here in the GitHub discussions or file a new issue if you found a bug or have a feature request.
7882
You can reach me via Twitter, too: [@metawops](https://twitter.com/metawops)
83+
84+
## Sponsoring
85+
86+
If this plugin adds value for you and you would like to help support continued development, please consider sponsoring this repository via [GitHub Sponsors](https://github.com/sponsors), [PayPal](https://paypal.me/stefanwolfrum) or [Buy me a coffee](https://www.buymeacoffee.com/metawops).
87+
88+
Made with ❤️ in Bonn, Germany.

main.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const DEFAULT_SETTINGS: Table2CSVSettings = {
2626
baseFilename: 'table-export',
2727
fileNumber: '001',
2828
sepChar: 'sepChar-semicolon',
29-
quoteDataChar: 'quoteChar-doubleQuotes',
29+
quoteDataChar: 'quoteChar-noQuote',
3030
saveToClipboardToo: false,
3131
removeCRLF: 'removeCRLF-space'
3232
}
@@ -282,7 +282,7 @@ class Table2CSVSettingTab extends PluginSettingTab {
282282

283283
new Setting(containerEl)
284284
.setName('Handling of CR/LF in data')
285-
.setDesc('Chose how to handle the occurance of return and linefeed characters in data cells.')
285+
.setDesc('Choose how to handle the occurance of return and linefeed characters in data cells.')
286286
.addDropdown( dropdown => dropdown
287287
.addOption('removeCRLF-clear', 'Remove all CR & LF characters')
288288
.addOption('removeCRLF-space', 'Replace all CR & LF characters with one space')

0 commit comments

Comments
 (0)