Skip to content

Commit

Permalink
Release 16.3.0 codebase
Browse files Browse the repository at this point in the history
  • Loading branch information
atrenton committed Dec 5, 2021
1 parent dd2e4b7 commit 97ee881
Show file tree
Hide file tree
Showing 17 changed files with 614 additions and 147 deletions.
2 changes: 1 addition & 1 deletion Build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Set-Location $PSScriptRoot
# EXAMPLE: "/p:SourceRevisionId=g$(Git-Latest-Commit)"
#-------------------------------------------------------------------------------
$properties = @('/p:Configuration=Release', "/p:Platform=$Platform",
'/p:Version=16.2.1-beta')
"/p:SourceRevisionId=g$(Git-Latest-Commit)")

$sln = '"{0}"' -f "$PSScriptRoot\src\MyJournal.Notebook.sln"

Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/).

## [16.3.0] - 2021-12-05

### Added

- Feature request: configure the notebook used • Issue \#[3] • released from beta

### Changed

- Upgraded OneNote XML schema from 2010 to 2013 version

### Removed

- OneNote 2010 is no longer supported

## [16.2.1-beta] - 2021-04-07

### Added
Expand Down Expand Up @@ -35,3 +49,4 @@ This project adheres to [Semantic Versioning](https://semver.org/).
[16.1.0]:https://github.com/atrenton/MyJournal.Notebook/releases/tag/v16.1.0
[16.2.0]:https://github.com/atrenton/MyJournal.Notebook/releases/tag/v16.2.0
[16.2.1-beta]:https://github.com/atrenton/MyJournal.Notebook/releases/tag/v16.2.1-beta
[16.3.0]:https://github.com/atrenton/MyJournal.Notebook/releases/tag/v16.3.0
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@

![screenshot](docs/README-screenshot.png)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/atrenton/MyJournal.Notebook?logo=github)](https://github.com/atrenton/MyJournal.Notebook/releases/latest)  [![Gitter chat](https://img.shields.io/gitter/room/atrenton/MyJournalNotebook?logo=gitter)](https://gitter.im/MyJournal-Notebook/community)  [![Keybase chat](https://img.shields.io/static/v1.svg?label=chat&message=on%20keybase&logo=keybase)](https://keybase.io/atrenton/chat)  [![GitHub issues](https://img.shields.io/github/issues/atrenton/MyJournal.Notebook?logo=github)](https://github.com/atrenton/MyJournal.Notebook/issues)  [![Tweets](https://img.shields.io/twitter/url?label=tweets&logo=twitter&style=plastic&url=https%3A%2F%2Ftwitter.com%2FArtTrenton)](https://twitter.com/ArtTrenton)
[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/atrenton/MyJournal.Notebook?color=blue&include_prereleases&logo=github)](https://github.com/atrenton/MyJournal.Notebook/releases)  [![GitHub Discussions](https://img.shields.io/github/discussions/atrenton/MyJournal.Notebook?color=green&logo=github)](https://github.com/atrenton/MyJournal.Notebook/discussions)  [![GitHub issues](https://img.shields.io/github/issues/atrenton/MyJournal.Notebook?logo=github)](https://github.com/atrenton/MyJournal.Notebook/issues)  [![Keybase chat](https://img.shields.io/static/v1.svg?label=chat&message=on%20keybase&logo=keybase)](https://keybase.io/atrenton/chat)  [![Tweets](https://img.shields.io/twitter/url?label=tweets&logo=twitter&style=plastic&url=https%3A%2F%2Ftwitter.com%2FArtTrenton)](https://twitter.com/ArtTrenton)

## About

Record your daily interactions, ideas and inspirations with this add-in for Microsoft® OneNote® 2010 / 2013 / 2016 Windows desktop versions.
Record your daily interactions, ideas and inspirations with this add-in for Microsoft® OneNote® Windows desktop software.

<div align="center">
<table hspace="25">
<tr>
<th scope="row">
Expand All @@ -26,7 +27,7 @@ Record your daily interactions, ideas and inspirations with this add-in for Micr
<br />Settings</th>
<td>
<ul>
<li>OneDrive storage account (beta)</li>
<li>OneDrive storage account (NEW)</li>
<li>Page color</li>
<li>Page title date format</li>
<li>Page rule lines</li>
Expand Down Expand Up @@ -58,24 +59,27 @@ Record your daily interactions, ideas and inspirations with this add-in for Micr
<td>Microsoft and OneNote are registered trademarks of Microsoft Corporation.</td>
</tr>
</table>
</div>

For additional information, check out the [**Wiki**](https://github.com/atrenton/MyJournal.Notebook/wiki).

## Requirements
## Prerequisites

- Microsoft Windows 7 OS or later<br />
- Microsoft .NET Framework 4.6.2 or later<br />
- Microsoft OneNote 2010 / 2013 / 2016 Windows desktop software (32-bit or 64-bit)<br />
- Microsoft [OneNote for Windows] desktop application software (32-bit or 64-bit)<br />
- Microsoft Visual Studio 2017 version 15.9 or later (developers only)<br />

## Installation

- To use this add-in, you must have a full Windows desktop version of OneNote 2010 / 2013 / 2016 that supports the creation of a local notebook. Both 32- and 64-bit versions of OneNote are supported as of [release 16.2.0].
- To use this add-in, you must have a Windows desktop version of OneNote installed as part of Office or [Microsoft 365](https://www.microsoft.com/en-us/microsoft-365). You can also download OneNote as a free standalone Windows desktop app with limited features (OneDrive notebook storage only). See the **Where to get it** section of the following document:
- [What's the difference between the OneNote versions?](https://support.microsoft.com/en-us/office/what-s-the-difference-between-the-onenote-versions-a624e692-b78b-4c09-b07f-46181958118f)

&NewLine;

- Unsupported versions of OneNote:
- OneNote for Windows 10
- [OneNote for Windows 10]
- [OneNote 2010](https://docs.microsoft.com/en-us/lifecycle/products/microsoft-onenote-2010 "Microsoft Lifecycle Extended End Date: 10/13/2020") &mdash; if you are still using it, install [release 16.2.0].

&NewLine;

Expand All @@ -89,6 +93,9 @@ For additional information, check out the [**Wiki**](https://github.com/atrenton
- [Select journal page color](docs/HowTo-Select-Page-Color.md)
- [Select journal page title date format](docs/HowTo-Select-Page-Title.md)
- [Select journal page rule lines format](docs/HowTo-Select-Rule-Lines.md)
- [Select OneDrive storage account](docs/HowTo-Select-OneDrive-Storage-Account.md) (NEW)

[latest release]:https://github.com/atrenton/MyJournal.Notebook/releases/latest
[latest release]:https://github.com/atrenton/MyJournal.Notebook/releases "latest by date including pre-releases"
[release 16.2.0]:https://github.com/atrenton/MyJournal.Notebook/releases/tag/v16.2.0
[OneNote for Windows]:https://support.microsoft.com/en-us/office/what-s-the-difference-between-the-onenote-versions-a624e692-b78b-4c09-b07f-46181958118f#windows "What's the difference between the OneNote versions?"
[OneNote for Windows 10]:https://support.microsoft.com/en-us/office/what-s-the-difference-between-the-onenote-versions-a624e692-b78b-4c09-b07f-46181958118f#windows "What's the difference between the OneNote versions?"
25 changes: 25 additions & 0 deletions docs/HowTo-Select-OneDrive-Storage-Account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# *MyJournal.Notebook*

---

## Usage

### :star: How-to: Select OneDrive Storage Account

![screenshot](usage/select-storage-account.png)

- The default add-in configuration saves your ***My Journal*** notebook on `local` storage.

- To save your notebook on your `OneDrive - Personal` cloud storage, you can select your Microsoft account in the **My Journal Notebook Options** dialog ```Save``` tab.

- To configure OneDrive access in OneNote 2016 and 2013:
Go to **File** &#187; **Account** &#187; **Connected Services** &#187; select **Add a Service** then **Storage** and choose OneDrive. See [How to add OneDrive as a service](https://support.microsoft.com/en-us/office/how-to-add-onedrive-as-a-service-3ae78a39-c0de-4c86-8abc-ad519b6de44e) if you need more help.

- To move an existing local notebook to OneDrive, see [Move a OneNote notebook to OneDrive](https://support.microsoft.com/en-us/office/move-a-onenote-notebook-to-onedrive-0af0a141-0bdf-49ab-9e50-45dbcca44082 "OneNote 2016, OneNote 2013, Office for business").

**PLEASE NOTE:** Microsoft® OneNote® &ndash; not this add-in &ndash; handles all the syncing of your notes between your computer and OneDrive. Your internet speed is a factor. For more information, see [Best practices for syncing notes in OneNote](https://support.microsoft.com/en-us/office/best-practices-for-syncing-notes-in-onenote-9c6e8fcc-3307-419c-ba77-58cadfe651d7).

<p align="right">
<a href="https://github.com/atrenton/MyJournal.Notebook/blob/master/README.md#usage">:arrow_left: README &ndash; Usage</a><br>
<a href="https://github.com/atrenton/MyJournal.Notebook/wiki/Configuration#movie_camera-quick-start-videos">:arrow_left: Wiki Configuration &ndash; Quick Start Videos</a>
</p>
2 changes: 2 additions & 0 deletions docs/HowTo-Select-Rule-Lines.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

![screenshot](usage/select-page-rule-lines-format.gif)

If rule lines are not working, check [Known Issues](./known-issues.md#rule-lines) for additional information.

<p align="right">
<a href="https://github.com/atrenton/MyJournal.Notebook/blob/master/README.md#usage">:arrow_left: README &ndash; Usage</a><br>
<a href="https://github.com/atrenton/MyJournal.Notebook/wiki/Configuration#movie_camera-quick-start-videos">:arrow_left: Wiki Configuration &ndash; Quick Start Videos</a>
Expand Down
8 changes: 4 additions & 4 deletions docs/debugging/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# About the DebugView-Filters.ini file
# About the DebugView-Filter.ini file

The **`DebugView-Filters.ini`** file is a [Sysinternals DebugView](https://docs.microsoft.com/en-us/sysinternals/downloads/debugview) filters file for debugging the **MyJournal.Notebook** add-in.
The **`DebugView-Filter.ini`** file is a [Windows Sysinternals DebugView](https://docs.microsoft.com/en-us/sysinternals/downloads/debugview) filters file for debugging the **MyJournal.Notebook** add-in.

## DebugView Menu Settings

Expand All @@ -20,11 +20,11 @@ The **`DebugView-Filters.ini`** file is a [Sysinternals DebugView](https://docs.
- Computer
- Select Connect Local

## How to load the **`DebugView-Filters.ini`** file
## How to load the **`DebugView-Filter.ini`** file

1. From the DebugView menu, select Edit > Filter/Highlight... (<kbd>Ctrl</kbd> + <kbd>L</kbd>)
1. Click the Load button
1. Navigate to the repo `docs\debugging` subdirectory and select the `DebugView-Filters.ini` file
1. Navigate to the repo `docs\debugging` subdirectory and select the `DebugView-Filter.ini` file
1. Click the Open button
1. Click the OK button
1. Save the filters configuration by closing and reopening DebugView
Expand Down
40 changes: 37 additions & 3 deletions docs/known-issues.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Known Issues

This document describes known issues with the My Journal Add-In for Microsoft OneNote.
<sup>Last Updated December 4, 2021</sup>

The following is the list of Known Issues for the **My Journal Add-In for Microsoft OneNote**:

- [Paper Size](./known-issues.md#paper-size)
- [Rule Lines](./known-issues.md#rule-lines)

## Paper Size

### Background:
### Background

This feature was added in release 16.1.0 to support a user's paper size preference
when printing a journal page. It defaults to the OneNote Auto (automatic) paper size.
Expand All @@ -17,7 +22,7 @@ Setting the paper size to any value other than Automatic will result in a fixed
height page size. Content exceeding this height overflows the background page
color.

### Workaround:
### Workaround

- Leave the My Journal Notebook paper size option set to Automatic.
- Use **File \> Print \> Print Preview** to see where your page breaks are.
Expand All @@ -27,3 +32,32 @@ color.
> And because OneNote is designed to capture your notes, not print out traditional
> pages, you won't find a page break option in OneNote. Go to **File \> Print \>**
> **Print Preview** to see how your pages will look when printed.
<br/>

## Rule Lines

### Background

The Add-In can be configured to create notebook pages with 4 different rule line
styles or none at all.

### Issue: Rule lines do not display in OneNote 2016 or later

Rule lines are not displayed in journal pages created by the Add-In with OneNote
2016 or later; works fine in earlier versions of OneNote.

### Workaround

- In OneNote, select **File \> Options \> Display** to change how OneNote looks.

- Check the following **Display** option:
:white_check_mark: Create all new pages with rule lines

- If you have set the **Rule Lines** style to `None` in the Add-In's **Page Settings**,
you can still set rule lines for the current page via the OneNote **View \>
Rule Lines** menu option.

- Also take note that the browser-based **OneNote for the web** (formerly OneNote
Web App) cannot display rule lines and page color. See [Differences between using
a notebook in the browser and in OneNote](https://support.microsoft.com/en-us/office/differences-between-using-a-notebook-in-the-browser-and-in-onenote-a3d1fc13-ac74-456b-b391-b633a62aa83f).
4 changes: 2 additions & 2 deletions docs/troubleshooting/OneNote-Library.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,8 @@ Function Get-RegAsm-x86-ChildPath {

Function Press-Any-Key
{
if ($Host.Name -notmatch 'ISE') {
Write-Host 'Press any key to continue. . .' -NoNewline
if (($Host.Name -eq 'ConsoleHost') -and (-not $env:WT_SESSION)) {
Write-Host "`nPress any key to continue. . ." -NoNewline
$Host.UI.RawUI.ReadKey('NoEcho, IncludeKeyDown') | Out-Null
}
}
Binary file added docs/usage/select-storage-account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions scripts/Common-Library.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ Function Handle-NativeCommandError {

Function Press-Any-Key
{
if ($Host.Name -notmatch 'ISE') {
Write-Host 'Press any key to continue. . .' -NoNewline
if (($Host.Name -eq 'ConsoleHost') -and (-not $env:WT_SESSION)) {
Write-Host "`nPress any key to continue. . ." -NoNewline
$Host.UI.RawUI.ReadKey('NoEcho, IncludeKeyDown') | Out-Null
}
}
Expand Down
Loading

0 comments on commit 97ee881

Please sign in to comment.