Skip to content

Commit

Permalink
Documentation/changelog: Merge CSV documentation to one
Browse files Browse the repository at this point in the history
  • Loading branch information
gsantner committed Oct 11, 2023
1 parent b093818 commit 3fb8815
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 12 deletions.
10 changes: 5 additions & 5 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If you have questions or found an issue please head to the [Markor project](http

## Line number support

Markor supports showing line numbers now. In the top file menu you can find a new option to enable numbers.
Markor supports showing line numbers now. In the document top file menu you can find the new checkbox to enable numbers.
It is supported in editor as well in view mode of documents (in code blocks).

![Line numbers](doc/assets/2023-10-11-line-numbers.webp)
Expand All @@ -81,15 +81,15 @@ While it might be not as much fleshed out like Markdown, it should fit for gener
![AsciiDoc](doc/assets/2023-10-11-asciidoc.webp)

## New format: CSV
[CSV file](https://en.wikipedia.org/wiki/Comma-separated_values) are supported now (in sense of syntax highlighting and preview).
For details see [CSV_README.md](doc/CSV_README.md), it was implemented in #1988, #1987, #1980, #1667.
[CSV files](https://en.wikipedia.org/wiki/Comma-separated_values) are supported now (in sense of syntax highlighting and preview).
For details see [CSV README](doc/2023-06-02-csv-readme.md), it was implemented in #1988, #1987, #1980, #1667.

* Editor with SyntaxHighlighter
* Each csv column is shown in a different unique color to see which csv-data belongs to which colum/header
* Preview as html-Table with export as pdf
* A csv column may contain markdown (See Example column in screenshot)
* A csv column may contain markdown (see column with picture in the screenshot)

![](doc/assets/csv/MakorCsvSyntaxh-Landscape.png) ![](doc/assets/csv/MakorCsvPreviewLandscape2.png)
![](doc/assets/csv/2023-06-25-csv-landscape.webp)

## New format: Org-Mode
The third and last new format newly added is Org-Mode. Note that currently only editor syntax highlighting and action buttons to make editing easier are available.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Markor is openly developed free software that accepts community contributions.
<br/>📚 Notebook: Store all documents on a common filesystem folder
<br/>📓 QuickNote: Fast accessible for keeping notes
<br/>☑️ To-Do: Write down your to-do
<br/>🖍 Formats: Markdown, todo.txt, Zim/WikiText, Plaintext, [csv](doc/CSV_README.md), ics, ini, json, toml, vcf, yaml
<br/>🖍 Formats: Markdown, todo.txt, Zim/WikiText, Plaintext, [csv](doc/2023-06-02-csv-readme.md), ics, ini, json, toml, vcf, yaml
<br/>📋 Copy to clipboard: Copy any text, including text shared into Markor
<br/>💡 Notebook is the root folder of documents and can be changed to any location on the filesystem. QuickNote and To-Do are textfiles
<br/>
Expand Down Expand Up @@ -62,14 +62,14 @@ While it might be not as much fleshed out like Markdown, it should fit for gener

### New format: CSV
[CSV file](https://en.wikipedia.org/wiki/Comma-separated_values) are supported now (in sense of syntax highlighting and preview).
For details see [CSV_README.md](doc/CSV_README.md), it was implemented in #1988, #1987, #1980, #1667.
For details see [CSV README](doc/2023-06-02-csv-readme.md), it was implemented in #1988, #1987, #1980, #1667.

* Editor with SyntaxHighlighter
* Each csv column is shown in a different unique color to see which csv-data belongs to which colum/header
* Preview as html-Table with export as pdf
* A csv column may contain markdown (See Example column in screenshot)

![](doc/assets/csv/MakorCsvSyntaxh-Landscape.png) ![](doc/assets/csv/MakorCsvPreviewLandscape2.png)
![](doc/assets/csv/2023-06-25-csv-landscape.webp)

### New format: Org-Mode
The third and last new format newly added is Org-Mode. Note that currently only editor syntax highlighting and action buttons to make editing easier are available.
Expand Down
6 changes: 2 additions & 4 deletions doc/CSV_README.md → doc/2023-06-02-csv-readme.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
.../doc/CSV_README.md

Last updated 2023-06-02 by k3b

## Information about csv files in markor

The android editor app [markor](https://github.com/gsantner/markor)
can handle [csv](https://en.wikipedia.org/wiki/Comma-separated_values) files since version v2.10.9

![](assets/csv/2023-06-25-csv-landscape.webp)

### Features

* Editor with SyntaxHighlighter
* ![](assets/csv/MakorCsvSyntaxh-Landscape.png)
* Each csv column is shown in a different unique color to see which csv-data belongs to which colum/header
* Preview as html-Table with export as pdf
* ![](assets/csv/MakorCsvPreviewLandscape2.png)
* A csv column may contain markdown formatting like **bold** or image
* Automatic discovering of `csv-field-delimiter-char` from found csv-header.
* Currently implemented: `;,:|` and `<tab>`
Expand Down
Binary file added doc/assets/csv/2023-06-25-csv-landscape.webp
Binary file not shown.
Binary file removed doc/assets/csv/MakorCsvPreviewLandscape2.png
Binary file not shown.
Binary file removed doc/assets/csv/MakorCsvSyntaxh-Landscape.png
Binary file not shown.

0 comments on commit 3fb8815

Please sign in to comment.