File Commands
Sunday, February 19, 2023
5:58 PM
Archive
Available only by right-clicking a section or notebook
Creates a zip file of all pages in the section or notebook, including all images and file attachments on each page. Also fixes the hyperlinks between pages within the context of the archive so the archive can stand on its own as a working directory of HTML files with live hyperlinks.
Export
Exports the current page or selected content as HTML, Word, PDF, Markdown, OneNote .one format, or internal OneNote XML.
If you choose HTML, you will be given the option to export each page as a single .htm file in the specified folder, or to archive each page into its own sub-folder, optionally with copies of the file attachments on each page.
There are some differences in the way OneMore exports pages from the way OneNote exports pages. If multiple pages are selected, OneMore will create a new file for each page. In comparison, if you choose to export as Word .docx, OneNote will append the content from all pages into a single file.
Note also that there is a difference between an .mht file and an .htm files, where the former has mime-type headers and footers that are not normally present in an HTML file.
Import
Import Word (.docx), PowerPoint (.pptx), Markdown (.md), OneNote (.one), or XML (.xml) by either appending content to the current page or creating a new page. Additionally, for PowerPoint, each slide can be imported into its own page so you could use OneNote as a PowerPoint presenter by entering full screen mode and using Ctrl-PgDn to move to the next slide.
You can import multiple Word, PowerPoint, or Markdown files by using a wildcard in the name, for example C:\docs\January*.md. Each file will be imported as a separate page; the Append option is not available when importing using wildcards.
Import Hyperlinks
Discovers all external hyperlinks on the current page, presents a dialog from which you can select one or more link to import. Each hyperlink is imported as a separate page.
Import Web Page
Imports the content of a Web page given its URL. The content can be added as a new page in the current section, as a new child page of the current page, or appended to the content of the current page. This can be run in one of two modes. By default, the page is imported as HTML and "optimized" by OneNote, meaning that styles are generally not preserved due to the inherent limitations of OneNote.
The second mode is to import the Web page as a series of static images. This will preserve most styling and layout of the page. It does this by internally printing the page to a PDF and then importing each page of the PDF as an image. This can be a time consuming process, taking up to 30 seconds, so give it time.
────────────────────────────────────────────────────────────────────────────────────────────────────
Analyze Data Storage
Generates a report, as a new page in the current section, showing how much disk space is consumed by OneNote notebooks and their recycle bins, sections, and pages. It indicates orphaned notebook backups for notebooks that are no longer opened in OneNote. It shows the size of the OneNote internal cache. And it shows a detailed breakdown of image sizes and file attachments embedded on pages along with an indication if the source of a file attachment no longer exists.
Each OneNote notebook maintains its own recycle bin. This can be cleared from the OneNote History menu.
Notebooks can be stored locally in the default OneNote data folder. Or they can be stored remotely in the cloud on OneDrive. Local notebooks are reported directly from the default data folder. Remote notebooks can only be analyzed by looking at their local backup copies as configured in the OneNote Options. The backup feature must be enabled in OneNote options and run at least once in order for the report to show useful information for remote notebooks.
Note that the detailed page analysis, especially when done over all sections in a notebook, can take some time to generate and result in a very large report page.
For large notebooks or sections with pages containing many images, it is possible that the Analyze command will run out of memory and crash OneMore. To avoid this, set the Thumbnails option to None. A summary of all images - count and total size - on each page will be reported rather than the size of each individual image.
File Quick Notes
OneNote Quick Notes are intended to capture small thoughts and ideas quickly and easily from Win + Alt + N or the OneNote system tray icon. All Quick Notes are filed into the same special section at the bottom of the OneNote window called, surprisingly, "Quick Notes". If you compile a large collection of Quick Notes, it's very easy for ideas to get lost, especially considering that these do not have Title fields.
The File Quick Notes command organizes your Quick Notes into a selected section or notebook and collates them using one of several options, set from the Quick Notes page in the Settings Dialog
Choose the Notebook option to file your Quick Notes into a chosen notebook. Notes will be collated into new sections, automatically named accordingly to the creation date of the note, or a #keyword in the first line of the note. The #keyword must be a single word (or phrase without spaces) and only the first hashtag #keyword is used.
Choose the Section option to file your Quick Notes into a chosen section. Each notes is moved as its own page into this section. The Title field is set to the first few words of the note. It's recommended that you also enable the Prepend the tile with the date that the note was created option.
────────────────────────────────────────────────────────────────────────────────────────────────────
Plugins
OneNote can execute plugins that can process a page or hierarchy using a program that you write. This provides a simple way to experiment with page adjustments.
|
When writing a PowerShell plugin, specify powershell or pwsh as the Command and enter and use the Arguments line to specify the -file argument pointing to your script as shown here.
The User Arguments field is used to pass additional arguments to your script or program. The first argument will always be the path of the incoming XML. User arguments will be appended to that. Be sure to quote strings if they might contain spaces.
The workflow is very simple.
- Create a plugin program that accepts one command line argument; the argument will specify the path to a file containing the page XML.
- Run the Plugin command, specifying the path to the program and any other arguments.
- The plugin must complete within 20 seconds or it will timeout and be aborted.
- The plugin must write any desired changes back to the file path it was given.
- If the plugin completes and has made changes to the XML file on disk then OneMore will update the current page with your updated XML from the file;
- If the plugin completes and has not made changes to the file then no changes are made to the current page.
- If you chose to create a new page then it will be created regardless of whether the plugin updated the XML file.
Any output that your plugin writes to stdout will be captured in the OneMore log file.
Note, if you run the plugin and a Web browser is invoked (IE) showing the XML file contents then you probably forgot to specify the right arguments to powershell.exe or python.exe.
You can use the special keyword $name in the Page Name field. This will be replaced with the name of the current page when you invoke the plugin from the Favorites menu or choose it from the drop-down list. For example, if you're on page "Forecasting" and the Page Name is set to "Quarterly $name" then the created page when it will be named "Quarterly Forecasting"
The default timeout - time allotted in which a plugin must complete - is 15 seconds. You can change that by entering the number of seconds into the Timeout field. If set to zero then the timeout is set to one hour.
The following environment variables are set when calling a plugin.
- PLUGIN_ASCHILD - set to true when the Create as child option is checked
- PLUGIN_CREATE - set to true when the Create as new page option is checked
- PLUGIN_PAGENAME - specifies the name of the page to create or update
- PLUGIN_SOURCE_PAGEID - the OneNote ID of the source page
- PLUGIN_SOURCE_SECTIONID - the OneNote ID of the source page's section
- PLUGIN_SOURCE_NOTEBOOKID - the OneNote ID of the source page's notebook
- PLUGIN_SOURCE_PAGENAME - the title of the source page
- PLUGIN_SOURCE_PAGEPATH - the hierarchy path of the source page, including notebook, section, and page name
- PLUGIN_SOURCE_PAGEURL - the OneNote URL of the source page
- PLUGIN_SKIPLOCK - set to true when the Skip locked sections option is checked
The OneNote page schema is defined in the 0336.OneNoteApplication_2013.xsd file in the References folder of the project repo.
#omwiki #omcommands
© 2020 Steven M Cohn. All rights reserved.
Please consider a sponsorship or one-time donation to support ongoing development
Created with OneNote.