Skip to content

Fix (file names): Decode OneNote's escape codes in section names #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
klangme1ster wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix (file names): Decode OneNote's escape codes in section names #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions ConvertOneNote2MarkDown-v2.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,24 @@ Describe "Remove-InvalidFileNameCharsInsertedFiles" -Tag 'Unit' {
}


Describe "ConvertFrom-OneNoteEscapedName" -Tag 'Unit' {

Context 'Behavior' {

It "Should decode OneNote's '^' codes in section names" {
'AI ^M ML' | ConvertFrom-OneNoteEscapedName | Should -Be 'AI / ML'
'Messen^J Konferenzen^J Seminare' | ConvertFrom-OneNoteEscapedName | Should -Be 'Messen& Konferenzen& Seminare'
'plain name' | ConvertFrom-OneNoteEscapedName | Should -Be 'plain name'
}

It "Should turn a decoded '/' into a dash in the directory name" {
'AI ^M ML' | ConvertFrom-OneNoteEscapedName | Remove-InvalidFileNameChars | Should -Not -Match '\^'
}

}

}

Describe "Encode-Markdown" -Tag 'Unit' {

Context 'Parameters' {
Expand Down
20 changes: 18 additions & 2 deletions ConvertOneNote2MarkDown-v2.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,22 @@ Function Remove-InvalidFileNameCharsInsertedFiles {
return $newName
}

Function ConvertFrom-OneNoteEscapedName {
[CmdletBinding()]
param (
[Parameter(Mandatory = $true,Position = 0,ValueFromPipeline = $true)]
[AllowEmptyString()]
[string]
$Name
)

process {
# OneNote stores characters that aren't allowed in its section file names as '^' codes in the section's name,
# e.g. a section named 'AI / ML' is reported as 'AI ^M ML', and 'DECT & Bluetooth' as 'DECT^J Bluetooth'
$Name.Replace('^M', '/').Replace('^J', '&')
}
}

Function Encode-Markdown {
[CmdletBinding()]
param (
Expand Down Expand Up @@ -681,7 +697,7 @@ Function New-SectionGroupConversionConfig {
$cfg['object'] = $sectionGroup # Keep a reference to the SectionGroup object
$cfg['kind'] = 'SectionGroup'
$cfg['id'] = $sectionGroup.ID # E.g. {9570CCF6-17C2-4DCE-83A0-F58AE8914E29}{1}{B0}
$cfg['nameCompat'] = $sectionGroup.name | Remove-InvalidFileNameChars
$cfg['nameCompat'] = $sectionGroup.name | ConvertFrom-OneNoteEscapedName | Remove-InvalidFileNameChars
$cfg['levelsFromRoot'] = $LevelsFromRoot
$cfg['uri'] = $sectionGroup.path # E.g. https://d.docs.live.net/0123456789abcdef/Skydrive Notebooks/mynotebook/mysectiongroup
$cfg['notesDirectory'] = [io.path]::combine( $NotesDestination.TrimEnd('/').TrimEnd('\').Replace('\', [io.path]::DirectorySeparatorChar), $cfg['nameCompat'] ) # No need to truncate. Section Group and Section names have a max length of 50, so we should never hit the absolute path, file name, or directory name limits on Windows
Expand Down Expand Up @@ -720,7 +736,7 @@ Function New-SectionGroupConversionConfig {
$sectionCfg['object'] = $section # Keep a reference to the Section object
$sectionCfg['kind'] = 'Section'
$sectionCfg['id'] = $section.ID # E.g {BE566C4F-73DC-43BD-AE7A-1954F8B22C2A}{1}{B0}
$sectionCfg['nameCompat'] = $section.name | Remove-InvalidFileNameChars
$sectionCfg['nameCompat'] = $section.name | ConvertFrom-OneNoteEscapedName | Remove-InvalidFileNameChars
$sectionCfg['levelsFromRoot'] = $cfg['levelsFromRoot'] + 1
$sectionCfg['pathFromRoot'] = "$( $cfg['pathFromRoot'] )$( [io.path]::DirectorySeparatorChar )$( $sectionCfg['nameCompat'] )".Trim([io.path]::DirectorySeparatorChar) # No need to truncate. Section Group and Section names have a max length of 50, so we should never hit the absolute path, file name, or directory name limits on Windows
$sectionCfg['pathFromRootCompat'] = $sectionCfg['pathFromRoot'] | Remove-InvalidFileNameChars
Expand Down