Getting Started

Prerequisites

Before working on the LiM documents, you will need to install oXygen XML Editor. You will also need a Github account.

Provide the DHIL with your GitHub account username. If you do not have a GitHub account, you can create a free account here: https://github.com/join.

Download and install oXygen:https://www.oxygenxml.com/xml_editor/download_oxygenxml_editor.html. Members of the LiM team should contact the DHIL regarding license keys.

Once you've made your GitHub account, let an administrator from the DHIL know your GitHub username and they will invite you to join the repository. This invitation may take up to an hour to wend its way through the email system (especially if you are using your SFU email). Once you receive that email, make sure to accept the invitation for the lim repository.

Setting up oXygen (First Time)

Installing Git Client

Make sure the Git Client add-on is installed, following these instructions: https://www.oxygenxml.com/doc/ug-addons/topics/git-addon.html

Setting up Repository

Once the Git Client is installed, you must now configure oXygen to use your user account. To do that, you must first generate a Personal Access Token (PAT) in GitHub to use as a password.

Generating GitHub Token

Navigate to GitHub (https://github.com), log in (if you aren't already), and then click on your user icon in the right hand corner to open the side menu. Then click "Settings":

In settings, click "Developer Settings" at the bottom of the left-hand menu

Then click "Personal access tokens" and select "Tokens (classic)"

Click on the right hand side dropdown menu labelled "Generate new token", and select "Generate new token (classic)"

Give your token a name (e.g. oXygen) and no expiration date

Then, select the "repo" and "user" scopes

Click "Generate Token" at the bottom of the screen

You will now see a token, which is effectively the same as a password for GitHub. Make sure to copy this by selecting the copy button (and keep the tab open)

Cloning the Repository

In oXygen, go to the Git menu and select "Clone New Repository":

In the dialog box, add the following:

Repository: https://github.com/sfu-dhil/lim Checkout branch: <Default branch> Destination path: [Wherever you want to put this folder]

At this point, you may be prompted to authenticate. To do that, put in your GitHub username and paste the GitHub token generated earlier as the password:

You should now see the repository cloning:

Once it has downloaded, you will be prompted to select a project. Make sure that you select the "lim-data.xpr" project, since that will have additional features for encoding:

You may get a dialog box that asks you to accept the project; click yes:

Misc.

Line Wrap

Go to the top panel, click on “Oxygen XML Editor” and select “Preferences”.

In the “Type filter text” box, type in the word “wrap”. Then, under “text”, check the box next to “Line wrap”.