Skip to content

Commit a861070

Browse files
committed
update the wiki Setup page
1 parent dd0a5ee commit a861070

File tree

2 files changed

+75
-74
lines changed

2 files changed

+75
-74
lines changed

docs/developers/Setup.htm

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -209,20 +209,21 @@ <H2 lang=yo style="FONT-SIZE: 14pt; FONT-FAMILY: Calibri; COLOR: #2e75b5; MARGIN
209209
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in 0in 0in 0.75in">&nbsp;</P>
210210
<P lang=yo style="MARGIN: 0in 0in 0in 0.375in"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">PS C:\Github\OneMore&gt; </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>.\update-sdk.ps1</SPAN></P>
211211
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
212-
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Install OneMore and Setup Registry</H1>
213-
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">Either download the latest release of OneMore or build the solution and run the generated MSI. This will create the initial Registry settings including the add-in COM registration pointing to the InprocServer32 path. You'll want to redirect these paths to your development tree so you won't have to continually copy the DLLs around.</P>
212+
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Configure Registry Settings</H1>
213+
<P style="MARGIN: 0in"><SPAN lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">During normal development, OneMore is compiled into </SPAN><SPAN lang=en-US style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">bin\x86\Debug. OneNote COM add-ins must be configured in the Windows Registry. After the initial build of the solution, the </SPAN><SPAN lang=yo style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>setregistry.ps1 </SPAN><SPAN lang=en-US style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">script can be used to </SPAN><SPAN lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">create the initial Registry settings including the add-in COM registration pointing to the InprocServer32 path. Note that using the development path means that you don't have to copy the output artifacts every time the projects are rebuilt.</SPAN></P>
214214
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
215215
<UL style="MARGIN-BOTTOM: 0in; unicode-bidi: embed; MARGIN-TOP: 0in; DIRECTION: ltr" type=disc>
216-
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Run the </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>setregistry.ps1</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> script as </SPAN><A href="Scripts.htm"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">explained on the Scripts page</SPAN></A><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> to redirect the settings to your development folders.</SPAN>
217-
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Optionally, run the included </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>iq.ps1</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"><SPAN style="mso-spacerun: yes">&nbsp; </SPAN>to confirm the settings are OK; this will work with any registered path</SPAN> </LI></UL>
216+
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Open an elevated PowerShell (v7) console and </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>cd</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> to the OneNote root folder containing the </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>setregistry.ps1</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> script.</SPAN>
217+
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Run the </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>setregistry.ps1</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"> script with no arguments from the solution root folder as </SPAN><A href="Scripts.htm"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">explained on the Scripts page</SPAN></A><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">.</SPAN>
218+
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Optionally, run the included </SPAN><SPAN style='FONT-SIZE: 9.5pt; FONT-FAMILY: "Lucida Console"; BACKGROUND: #e8e8e8; COLOR: #172b4d'>iq.ps1</SPAN><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri"><SPAN style="mso-spacerun: yes">&nbsp; </SPAN>to confirm the settings are OK.</SPAN> </LI></UL>
218219
<P lang=yo style="FONT-SIZE: 12pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
219220
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Recently Tested With</H1>
220221
<P lang=yo style="FONT-SIZE: 12pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
221222
<UL style="MARGIN-BOTTOM: 0in; unicode-bidi: embed; MARGIN-TOP: 0in; DIRECTION: ltr" type=disc>
222-
<LI style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Windows 11 Pro 22H2 </SPAN><SPAN lang=en-US style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">22621.1344</SPAN>
223+
<LI style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Windows 11 Pro 23H2 </SPAN><SPAN lang=en-US style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">22631.5335</SPAN>
223224
<LI style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Windows 11 SDK </SPAN><SPAN lang=en-US style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">10.0.22621.0</SPAN>
224-
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Visual Studio 2022 17.5.1</SPAN>
225-
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">OneNote® 2021 MSO (Version 2302 Build 16.0.16130.20186) 64-bit </SPAN></LI></UL>
225+
<LI lang=yo style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">Visual Studio 2022 17.13.7</SPAN>
226+
<LI style="MARGIN-BOTTOM: 0px; VERTICAL-ALIGN: middle; MARGIN-TOP: 0px"><SPAN style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri">OneNote® 2021 MSO (Version 2504 Build 16.0.18730.20186) 64-bit </SPAN></LI></UL>
226227
<P lang=yo style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in">&nbsp;</P>
227228
<H1 lang=yo style="FONT-SIZE: 16pt; FONT-FAMILY: Calibri; COLOR: #1e4e79; MARGIN: 0in">Dependencies</H1>
228229
<P style="FONT-SIZE: 11.5pt; FONT-FAMILY: Calibri; MARGIN: 0in"><SPAN lang=yo>This is a list of nuget packages and libraries that OneMore depends on and are required to build. The nuget packages require that VS Nuget Package Manager settings include a link to </SPAN><A href="https://api.nuget.org/v3/index.json"><SPAN lang=en-US>https://api.nuget.org/v3/index.json</SPAN></A><SPAN lang=en-US>.</SPAN></P>

0 commit comments

Comments
 (0)