Skip to content

Commit 668f940

Browse files
authored
Update Wiki (#550)
* Update Wiki and screenshots to match current released version and add options. * Add documentation for external database connections. * Add MOTW note. * Add missed checkboxes and details.
1 parent 53e4039 commit 668f940

15 files changed

+84
-20
lines changed

Wiki/Installation.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Install
22
1. Download the [latest **Version_Control_vX.X.X.zip**](https://github.com/joyfullservice/msaccess-vcs-integration/releases/latest).
33
2. Extract `Version Control.accda` from the zip archive.
4-
3. *(Optional)* Adjust install options (see below).
5-
4. Click **Install Add-In**.
4+
3. Remove "Mark of the Web (MOTW)", if needed. See [this blog post](https://nolongerset.com/install-vcs-addin/) for additional information. <p>*NOTE:* MOTW does not always get set on files, and won't if you extract with 7Zip.
5+
4. *(Optional)* Adjust install options (see below).
6+
5. Click **Install Add-In**.
67

78
![Install Form Image](img/install.jpg)
89

@@ -11,8 +12,18 @@
1112

1213
|Setting <img width = 175> |**Default** <p> *(Setting)*|Description
1314
|-|:-:|:-
14-
|**Trust Add-In Folder**|**Default: On**|During installation, the VCS Addin install folder will be added as a trusted location in Microsoft Access/Office. This allows Access to load the Add-In correctly in some protected setups, and will enable faster loading in others. The install location is `C:\Users\%username%\AppData\Roaming\MSAccessVCS\`
15-
|**Open after install to trust add-in file**|**Default: Off**|In some protected computing environments (I.e. Government, Banking), the Add-In must be opened from the install location to be properly trusted. This option will open the add-in file immediately after install, and give you the opportunity to trust the file.
15+
|**Trust Add-In Folder**|**Default: On**|During installation, the VCS Addin install folder will be added as a trusted location in Microsoft Access/Office. This allows Access to load the Add-In correctly in some protected setups, and will enable faster loading in others. The default install location is `C:\Users\%username%\AppData\Roaming\MSAccessVCS\`
16+
|**Advanced Options**|**Default: Off**|In some protected computing environments you may need to select additional options. See below for more details.
17+
18+
![Install Form Image](img/install-AdvancedOptions.jpg)
19+
20+
|Setting <img width = 175> |**Default** <p> *(Setting)*|Description
21+
|-|:-:|:-
22+
|**Use Ribbon Addin**|**Default: On**|With Version 4 and up the addin and most features can be directly launched with a custom ribbon.
23+
||_On_|Install the ribbon and load to Access's ribbon. The ribbon will automatically load when Access loads, making launching version control much simpler.
24+
||_Off_|Do not install the Ribbon. You can still load the Addin after installation by going to [Database Tools]>[Add-Ins]>[VCS Open] or [VCS Export All Source].
25+
|**Open add-in after installing to trust the add-in file**|**Default: Off**|In some protected computing environments (I.e. Government, Banking), the Add-In must be opened from the install location to be properly trusted. This option will open the add-in file immediately after install, and give you the opportunity to trust the file.
26+
|**Install Folder**||By default, the addin will be installed to `C:\Users\%username%\AppData\Roaming\MSAccessVCS\`. If you need to select an alternate location for installation due to your development environment, security settings, etc., you can change the installation Folder. <p> **WARNING: You MUST _completely uninstall_ the Addin prior to changing the installation folder. Failure to do this may lead to unexpected issues and difficulty removing the addin.**
1627

1728
# Uninstall
1829
[Click here for Uninstall Instructions](<Options#Remove Add-In>)

Wiki/Options.md

Lines changed: 68 additions & 15 deletions
Large diffs are not rendered by default.

Wiki/Supported-Objects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The *Testing* column indicates whether a test item and testing code has been cre
6666
|Relationships |✔️|✔️|clsDbRelation
6767
|Nav. Pane Groups |✔️|✔️|clsDbNavPaneGroup
6868
|Embedded Office Theme(s) |✔️|✔️|clsDbTheme
69-
|CommandBars |||
69+
|CommandBars |❌<p>(yet)|❌<p>(yet)|See [Discussion 478](https://github.com/joyfullservice/msaccess-vcs-addin/discussions/478) for more details.
7070
|💼 **VBE PROJECT**
7171
|Project Properties |✔️|✔️|clsDbVbeProject
7272
|Compilation Arguments |✔️|✔️|clsDbVbeProject
26.8 KB
Loading

Wiki/img/install.jpg

22 Bytes
Loading

Wiki/img/main.jpg

-753 Bytes
Loading
61.7 KB
Loading

Wiki/img/options-Databases.jpg

44 KB
Loading

Wiki/img/options-build.jpg

4.53 KB
Loading

Wiki/img/options-encryption.jpg

-56 KB
Binary file not shown.

0 commit comments

Comments
 (0)