From 6fdae87c5a49d9fb6218a8d995e553db8f6399e5 Mon Sep 17 00:00:00 2001 From: Raoul Jacobs Date: Fri, 21 Nov 2025 19:44:59 +0100 Subject: [PATCH] docs: Update README to clarify CSV export format and hierarchical data representation --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 72aff6f..8910e78 100644 --- a/README.md +++ b/README.md @@ -169,14 +169,26 @@ Standard Markdown task checkboxes: CSV with dynamic columns (comma-separated by default, configurable to semicolon): ```csv -CustomerName,ProjectName,Header1,Header2,Header3,Task +CustomerName,Level1,Level2,Level3,Task Customer A,Project 1,Section,Outstanding task Customer A,Project 1,Section,Task with sub-items Customer A,Project 1,Section,Sub-task (nested) Customer A,Project 1,Section,Subsection,Another task ``` -The delimiter can be changed to semicolon (`;`) in the plugin settings for better compatibility with European Excel versions. +Notes: +- **Level columns**: The plugin uses generic `Level1..LevelN` columns for hierarchical path data. These contain, in order: any subfolder segments under the customer folder, then the project (markdown file) name, followed by markdown header segments and parent task text as present. +- **Compression**: When `Compress Levels` is enabled the CSV will omit empty trailing `Level` columns for each row; when disabled rows are padded to the maximum level depth. +- The delimiter can be changed to semicolon (`;`) in the plugin settings for better compatibility with European Excel versions. + +Example + +For a file under the `Customers` folder such as `Customers///.md` containing a top-level task in a `Section`, a produced CSV row will look like: + +```csv +CustomerName,Level1,Level2,Task +,,,Section - Outstanding task +``` ## Technical Details