Skip to content

Commit

Permalink
v6.5.1 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@stevencohn
stevencohn committed Aug 25, 2024
1 parent f72513d commit 59efa13
Show file tree
Hide file tree
Showing 18 changed files with 616 additions and 161 deletions.
8 changes: 7 additions & 1 deletion docs/commands/File Commands.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,15 @@ <H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">The following environment variables are set when calling a plugin.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<UL style="MARGIN-BOTTOM: 0in; unicode-bidi: embed; MARGIN-TOP: 0in; DIRECTION: ltr" type=disc>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_ASCHILD - set to true when the&nbsp;Create as child&nbsp;option is checked</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_CREATE - set to true when the&nbsp;Create as new page&nbsp;option is checked</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_PAGENAME - specifies the name of the page to create or update</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_ASCHILD - set to true when the&nbsp;Create as child&nbsp;option is checked</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_PAGEID - the OneNote ID of the source page</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_SECTIONID - the OneNote ID of the source page's section</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_NOTEBOOKID - the OneNote ID of the source page's notebook</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_PAGENAME - the title of the source page</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_PAGEPATH - the hierarchy path of the source page, including notebook, section, and page name</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SOURCE_PAGEURL - the OneNote URL of the source page</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PLUGIN_SKIPLOCK - set to true when the&nbsp;Skip locked sections&nbsp;option is checked</SPAN> </LI></UL>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in 0in 0in 0.375in">&nbsp;</P>
<P lang=yo style="MARGIN: 0in"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">The OneNote page schema is defined in the </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>0336.OneNoteApplication_2013.xsd</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> file in the Properties folder of the project repo.</SPAN></P>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/Page Commands.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ <H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: black; MARGIN: 0in">Copies or moves select content from the current page to a new page. The new page is positioned after the current page in incremental order as snippets of content are copied or moved.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: black; MARGIN: 0in">&nbsp;</P>
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Create Pages from List</H1>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: black; MARGIN: 0in">Generates pages in the current section from a list of page names where the list could be a bulleted list, a numbered list, a column from a table, the first column from an embedded spreadsheet, or OCR text from an embedded image.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: black; MARGIN: 0in">Generates pages in the current section from a list of page names where the list could be a bulleted list, a numbered list, a column from a table, the first column from an embedded spreadsheet, or OCR text from an embedded image. Note that this is similar to the built-in <SPAN style="FONT-STYLE: italic">Link to Pages</SPAN> context menu command; while it does not link to the pages from the list, it will create pages from more formats than <SPAN style="FONT-STYLE: italic">Link to Pages</SPAN>.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: black; MARGIN: 0in">&nbsp;</P>
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Duplicate Page</H1>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: gray; MARGIN: 0in"><SPAN style="FONT-STYLE: italic">Available only from the page context menu</SPAN></P>
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/Reminder Commands.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ <H2 lang=yo style="FONT-SIZE: 14pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">OneMore will scan alls reminders and send notification immediately after OneNote is started. It will then continue to scan once every five minutes. You may start to see notification for a particular reminder every five minutes however this will become once every 10 minutes, then once every hour, and then once every 12 hours based on how long you have OneNote running. This simple progressive schedule is to avoid being overwhelmed when continuing to dismiss a reminder.</SPAN> </LI></UL>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Strikethrough Completed To Do Tags</H1>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">Toggles strikethrough text next to all completed/incompleted tags</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">Toggles strikethrough text next to all completed/incompleted To Do tags. If a tag is marked completed (checked), then <SPAN style="TEXT-DECORATION: line-through">strikethrough </SPAN>styling will be applied to the text. If it is not completed, any strikethrough styling will be removed.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<P><CITE lang=yo style="FONT-SIZE: 9pt; FONT-FAMILY: Calibri; COLOR: #595959; MARGIN: 0in">#omwiki #omcommands</CITE></P>
Expand Down
8 changes: 8 additions & 0 deletions docs/commands/Search and Tag Commands.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,14 @@ <H2 lang=yo style="FONT-SIZE: 14pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN
<UL style="MARGIN-BOTTOM: 0in; unicode-bidi: embed; MARGIN-TOP: 0in; DIRECTION: ltr" type=circle>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">This is equivalent to </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e9e9e9'>(tag AND (#tag2 OR tag3))</SPAN> </LI></UL></LI></UL>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<H2 lang=yo style="FONT-SIZE: 14pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN: 0in">Reserved Hashtags</H2>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">Note the following hashtag names purposely are not preceeded with # symbols so they don't take effect on this page.</P>
<H2 lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN: 0in">&nbsp;</H2>
<UL style="MARGIN-BOTTOM: 0in; unicode-bidi: embed; MARGIN-TOP: 0in; DIRECTION: ltr" type=disc>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style='FONT-SIZE: 10pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #f1f1f1; COLOR: black'>KeepHashtags</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> - When present on a page, following a SkipHashtags hashtag, the hashtag scanner will resume looking for hashtags on the page.</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style='FONT-SIZE: 10pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #f1f1f1; COLOR: black'>SkipHashtags</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> - When present on a page, the hashtag scanner will ignore all hastags until the bottom of the page or until it sees the keephasthags hashtag.</SPAN>
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style='FONT-SIZE: 10pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #f1f1f1; COLOR: black'>SkipWiki</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> - When a page title includes this tag, it will not be included in the output of the Wiki generation script </SPAN><A href="https://github.com/stevencohn/OneMore/blob/main/docs/build.ps1"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">/docs/Build.ps1</SPAN></A><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> in the OneMore repo. This does not apply when the tag is in the page body.</SPAN> </LI></UL>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
<H2 lang=yo style="FONT-SIZE: 14pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN: 0in">Operations</H2>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">The <SPAN style="FONT-STYLE: italic">Index</SPAN> button will create a new page with an index of selected pages.</P>
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">The <SPAN style="FONT-STYLE: italic">Copy</SPAN> button will copy the selected pages to another section or notebook.</P>
Expand Down
Loading

0 comments on commit 59efa13

Please sign in to comment.