Skip to content

Commit

Permalink
Bugfixes + Welcome msg + Integration of Pandoc
Browse files Browse the repository at this point in the history
Fix #27 : Strange (reproduced) line break behavior 
Add a welcome message
Zip bundle now includes PanDoc binaries
  • Loading branch information
alxnbl authored Apr 27, 2021
1 parent 0ed24b4 commit 5a2af4d
Show file tree
Hide file tree
Showing 14 changed files with 4,234 additions and 38 deletions.
10 changes: 9 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
GNU GENERAL PUBLIC LICENSE
This code is released under the [GPL] version 4

OneNote Md Exporter embeds PanDoc document covertor
Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>


----------------------------------------------------------------------

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Expand Down
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ It offers an alternative to migration based on EverNote export (OneNote-> ENEX -

# Requirements

The tool requires Microsoft Office to be installed, at least OneNote and Word.

The software requires OneNote and Word from the Microsoft Office suite.
[OneNote for Windows 10](https://www.microsoft.com/en-us/p/onenote-for-windows-10/9wzdncrfhvjl) is not supported.

Tested on :
Expand All @@ -23,7 +22,7 @@ Comparison between OneNote Md Exporter and ENEX Export methods. Choose the one b
| --- | --- | --- |
| Formatted content |||
| **Hierarchy of sections** | ✅ Sub-Notebooks | 🟠 Flattened as Tag |
| **Page order inside a section** |Sub-Notebooks | 🔴 All pages part of a single Notebook |
| **Page order inside a section** || 🔴 All pages part of a single Notebook |
| **Page hierarchy (level)** | ✅ Page title prefix <br/>(--- \<Page\>) | 🔴 |
| Attachments | ✅ At their original position | 🟠 At the end of the page |
| Note metadata |||
Expand All @@ -47,7 +46,6 @@ Comparison between OneNote Md Exporter and ENEX Export methods. Choose the one b

## Installation

* Install PanDoc : https://pandoc.org/installing.html
* Download the last release of OneNoteMdExporter from [Releases page](https://github.com/alxnbl/onenote-md-exporter/releases)
* Unzip OneNote Md Exporter

Expand All @@ -56,7 +54,7 @@ Comparison between OneNote Md Exporter and ENEX Export methods. Choose the one b
1. Open OneNote
* Launch OneNote and be sure that notebooks to export are opened
2. Export
* From OneNoteMdExporter folder, start *alxnbl.OneNoteMdExporter.exe*
* From OneNoteMdExporter folder, start `alxnbl.OneNoteMdExporter.exe`
* Choose the Notebook to export
* Choose the destination format
* Go take a coffee ☕
Expand All @@ -69,13 +67,24 @@ In case of error during export very that :
* Both OneNote and the tool are NOT run as administrator
* PanDoc is correctly installed

## Command line

Run `alxnbl.OneNoteMdExporter.exe --help` for instructions.

## Build sources

* Install DotNet 5 : https://dotnet.microsoft.com/download/dotnet/3.1
* Install DotNet 5 : https://dotnet.microsoft.com/download/dotnet/5.0
* Install PanDoc : https://pandoc.org/installing.html
* Clone this repository
* Build using Visual Studio 2019 or MSBUILD.exe (`dotnet build` do not currently support COMReference : https://aka.ms/msbuild/MSB4803)

## Translation

You can contribute by adding translation in your language. You just need to :
* fork the repo
* copy file `/src/Resources/trad.en.json`, translate it, and save the new file into `trad.<TwoLetterLanguageCode>.json` (list of language code [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)).
* send a [pull-request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)

# Technical characteristics

* DotNet 5 self-contained console application
Expand All @@ -86,12 +95,16 @@ In case of error during export very that :
* Extensible : new export format can be easily added to the code
* Begining of integration test (need to be completed)

# Disclaimer
# Licence

Released under the GPL, version 3.

This software carries no warranty of any kind. Some data can be lost during the export process. I recommand to review your notes after export and keep a backup of your OneNote notebooks just in case.

Some data can be lost during the export process. I recommand you to review your notes after export and keep a backup of your OneNote notebooks just in case.
OneNote Md Exporter embeds PanDoc, a document convertor software,

# Contributions

Bugs and enhancements can be reported under: https://github.com/alxnbl/onenote-md-exporter/issues.
Bugs and enhancements can be reported under: https://github.com/alxnbl/onenote-md-exporter/issues.

Contribution are welcome, please open a PR.
93 changes: 93 additions & 0 deletions pandoc/pandoc-2.13/COPYING.rtf

Large diffs are not rendered by default.

205 changes: 205 additions & 0 deletions pandoc/pandoc-2.13/COPYRIGHT.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,205 @@
Pandoc
Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>

With the exceptions noted below, this code is released under the [GPL],
version 2 or later:

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

The GNU General Public License is available in the file COPYING.md in
the source distribution. On Debian systems, the complete text of the
GPL can be found in `/usr/share/common-licenses/GPL`.

[GPL]: https://www.gnu.org/copyleft/gpl.html

Pandoc's complete source code is available from the [Pandoc home page].

[Pandoc home page]: https://pandoc.org

Pandoc includes some code with different copyrights, or subject to different
licenses. The copyright and license statements for these sources are included
below. All are GPL-compatible licenses.

----------------------------------------------------------------------
The modules in the `pandoc-types` repository (Text.Pandoc.Definition,
Text.Pandoc.Builder, Text.Pandoc.Generics, Text.Pandoc.JSON,
Text.Pandoc.Walk) are licensed under the BSD 3-clause license:

Copyright (c) 2006-2021, John MacFarlane

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.

* Neither the name of John MacFarlane nor the names of other
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

----------------------------------------------------------------------
Pandoc's templates (in `data/templates`) are dual-licensed as either
GPL (v2 or higher, same as pandoc) or (at your option) the BSD
3-clause license.

Copyright (c) 2014--2021, John MacFarlane

----------------------------------------------------------------------
src/Text/Pandoc/Writers/Muse.hs
Copyright (C) 2017-2020 Alexander Krotov

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Writers/Texinfo.hs
Copyright (C) 2008-2021 John MacFarlane and Peter Wang

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Writers/OpenDocument.hs
Copyright (C) 2008-2021 Andrea Rossato and John MacFarlane

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Writers/Org.hs
Copyright (C) 2010-2021 Puneeth Chaganti, John MacFarlane, and
Albert Krewinkel

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Writers/ZimWiki.hs
Copyright (C) 2017 Alex Ivkin

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/Docx.hs
src/Text/Pandoc/Readers/Docx/*
Copyright (C) 2014-2020 Jesse Rosenthal

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/Textile.hs
Copyright (C) 2010-2021 Paul Rivier and John MacFarlane

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/TikiWiki.hs
Copyright (C) 2017 Robin Lee Powell

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/JATS.hs
Copyright (C) 2017-2018 Hamish Mackenzie

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/EPUB.hs
Copyright (C) 2014-2021 Matthew Pickering and John MacFarlane

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/Org.hs
src/Text/Pandoc/Readers/Org/*
test/Tests/Readers/Org/*
Copyright (C) 2014-2021 Albert Krewinkel

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Lua.hs
src/Text/Pandoc/Lua/*
test/lua/*
Copyright (C) 2017--2021 Albert Krewinkel and John MacFarlane

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/Jira.hs
src/Text/Pandoc/Writers/Jira.hs
test/Tests/Readers/Jira.hs
Copyright (C) 2019--2021 Albert Krewinkel

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
src/Text/Pandoc/Readers/FB2.hs
Copyright (C) 2018--2019 Alexander Krotov

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
data/pandoc.lua
Copyright (C) 2017-2021 Albert Krewinkel

Released under the GNU General Public License version 2 or later.

----------------------------------------------------------------------
The dzslides template contains JavaScript and CSS from Paul Rouget's
dzslides template.
https://github.com/paulrouget/dzslides

Released under the Do What the Fuck You Want To Public License.

------------------------------------------------------------------------
Pandoc embeds a Lua interpreter (via hslua).

Copyright © 1994–2020 Lua.org, PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Loading

0 comments on commit 5a2af4d

Please sign in to comment.