Skip to content

Commit

Permalink
Update Wiki (#550)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
hecon5 authored Oct 22, 2024
1 parent 53e4039 commit 668f940
Show file tree
Hide file tree
Showing 15 changed files with 84 additions and 20 deletions.
19 changes: 15 additions & 4 deletions Wiki/Installation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Install
1. Download the [latest **Version_Control_vX.X.X.zip**](https://github.com/joyfullservice/msaccess-vcs-integration/releases/latest).
2. Extract `Version Control.accda` from the zip archive.
3. *(Optional)* Adjust install options (see below).
4. Click **Install Add-In**.
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.
4. *(Optional)* Adjust install options (see below).
5. Click **Install Add-In**.

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

Expand All @@ -11,8 +12,18 @@

|Setting <img width = 175> |**Default** <p> *(Setting)*|Description
|-|:-:|:-
|**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\`
|**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.
|**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\`
|**Advanced Options**|**Default: Off**|In some protected computing environments you may need to select additional options. See below for more details.

![Install Form Image](img/install-AdvancedOptions.jpg)

|Setting <img width = 175> |**Default** <p> *(Setting)*|Description
|-|:-:|:-
|**Use Ribbon Addin**|**Default: On**|With Version 4 and up the addin and most features can be directly launched with a custom ribbon.
||_On_|Install the ribbon and load to Access's ribbon. The ribbon will automatically load when Access loads, making launching version control much simpler.
||_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].
|**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.
|**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.**

# Uninstall
[Click here for Uninstall Instructions](<Options#Remove Add-In>)
83 changes: 68 additions & 15 deletions Wiki/Options.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Wiki/Supported-Objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The *Testing* column indicates whether a test item and testing code has been cre
|Relationships |✔️|✔️|clsDbRelation
|Nav. Pane Groups |✔️|✔️|clsDbNavPaneGroup
|Embedded Office Theme(s) |✔️|✔️|clsDbTheme
|CommandBars |||
|CommandBars |❌<p>(yet)|❌<p>(yet)|See [Discussion 478](https://github.com/joyfullservice/msaccess-vcs-addin/discussions/478) for more details.
|💼 **VBE PROJECT**
|Project Properties |✔️|✔️|clsDbVbeProject
|Compilation Arguments |✔️|✔️|clsDbVbeProject
Expand Down
Binary file added Wiki/img/install-AdvancedOptions.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/install.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/main.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Wiki/img/options-Databases-Connection.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Wiki/img/options-Databases.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/options-build.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed Wiki/img/options-encryption.jpg
Binary file not shown.
Binary file modified Wiki/img/options-export.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/options-general.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/options-printer-settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/options-settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Wiki/img/options-table-data.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 668f940

Please sign in to comment.