Skip to content

Latest commit

 

History

History
98 lines (80 loc) · 5.42 KB

CHANGELOG.md

File metadata and controls

98 lines (80 loc) · 5.42 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project follows something close to Semantic Versioning as there is no public API yet then the following guide applies.

  • Increment the patch number when you ship a bug fix
  • Increment the minor version number when adding a new feature or set of features and any current bug fixes not yet released
  • Increment the major version when significantly overhaul the user interface, or rewrite all internals.

[1.3.0] - 2021-06-16

Added

  • Exporting to 'pandoc-markdown' now uses YANOM's metadata parser giving wider choice of metadata keys to be parsed or not parsed. The export only produces a YAML front matter section.
  • Can now add a tag prefix to tag metadata values in front matter sections. This is not required by most markdown readers, but is an option if required.
  • Re-write of algorithm to match links between note pages. Now only a single link to a page needs to be valid in any notebook in a nsx export file for renamed links to that page to be corrected

Fixed

  • Fix html tag widths were coded incorrectly when cleaning nsx html formatting prior to any conversion.
  • Image tag prefix is now correctly implemented.
  • Under a packaged runtime environment replacing a missing config.ini would fail.

Other

  • Add tests for chart processing, image processing, metadata processing, pandoc processing, synology attachment processing, zip file handling, timer, inter note link processing, notes converter, nsx file converter, synology notebook processing, synology note page processing.
  • Windows pyinstaller package is no longer 'onefile' due to Windows Defender issues

[1.2.0] - 2021-05-25

Added

  • Add support for export files from the Synology DSM Note-Station web app. Export files are slightly different format from the desktop app.
  • For Note-Station conversion, add option to select chart elements to reproduce image, csv and data table, or any combination of the three.
  • Removed requirement to install pandoc for packaged versions.

Fixed

  • Testing identified a potential issue where an HTML a anchor tag that does not have a href inside of it would cause an error when searching for links between note pages during html to markdown conversion.

Other

  • Code refactoring and cleaning
    • sn_note_writer refactored to generic file writer and used by additional converters
    • Minor simplifications in nsx_file_converter and sn_notebook
    • sn_zipfile reader simplified to function
    • conversion_settings simplified form factory object generator to a single class and methods for quick settings for simpler management of settings that should persist when selecting a quick setting
    • chart_processing moved Chart class to be an inner class of ChartProcessor and changed signature of init to accept 3 booleans for the three available chart options.
  • Additional documentation added, docstrings and README files
  • Additional tests writen for checklist processing, helper functions, chart processing, conversion settings, file writer
  • Changed pandoc version testing from distutils to packaging

[1.1.0] - 2021-05-14

Added

  • Support for iframes in HTML to Markdown and NSX files to Markdown
  • Progress bars during conversion

Fixed

  • Note-Station program exports the 'My Notebook' with no title. Now detect this and give the notebook it's 'My Notebook' title.
  • Image width detection now detects widths with px appended to the width

[1.0.0] - 2021-05-09

Initial release functionality

  • project wiki covering installation, use and functionality etc.
  • Convert Note-Station .nsx export files to Markdown or HTML
  • Convert HTML to Markdown
  • Convert Markdown to HTML
  • Convert Markdown to a different format of Markdown
  • List of available Markdown formats that can be used as inputs or outputs
    • CommonMark (Used by Joplin)
    • GFM - Git Flavoured Markdown (Typora, Git Hub, Haroopad)
    • Obsidian formatted markdown
    • MultiMarkdown (MultiMarkdown Composer)
    • Pandoc markdown
    • Pandoc markdown-strict
    • QOwnNotes optimised markdown-
  • Note content that will be converted successfully
    • Headers
    • Bulleted lists
    • Numbered lists
    • Checklists
    • Tables
    • Images
    • Image width where supported in Markdown
    • IFrames
    • Metadata - support JSON, TOML or YAML front matter, and meta tags in HTML
    • Tags
      • included in front matter, html header or as plain text with an optional prefix character
      • option to split grouped tags photography/landscape/winter becomes #photography, #landscape, #winter
      • option to remove spaces from tag names
    • Tags
    • File attachments are maintained
    • Note-Station specific features
      • Charts are recreated. An image is placed on the page, along with a data table of the chart data, and a link to a csv file of the data.
      • Links between note pages.
      • Note-Station audio notes - are attached as an attachment
      • Option to include creation time in file name