Skip to content

Commit

Permalink
Updated a few docs to clarify some instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mhawkinsbasis committed Sep 19, 2023
1 parent 12a1fb1 commit cba2f38
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 9 deletions.
Binary file added docs/installation/_images/users/local/i6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/installation/docker_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import UnderConstruction from '@site/src/components/PageTools/UnderConstruction'
This section of the documentation will cover the steps required for users who wish to develop using Docker. Changes to your code
will be made on your development machine, and the resulting application will be run in Docker.

## Downloading Docker
## 1. Downloading Docker

The installation process for Docker will differ slightly between Windows, Mac and Linux users. See the section below that corresponds to your operating system.

Expand Down Expand Up @@ -56,7 +56,7 @@ It is recommended to download the latest version of Windows Subsystem for Linux.
** 2. Verify Installation: **
>- Open a terminal and run the command `docker --version` to verify that Docker is installed and working correctly. -->

## Configuration
## 2. Configuration

Once Docker Desktop has been downloaded, search for the latest DWCJ image, which is currently under the name `dwcjava/sandbox`.

Expand All @@ -73,7 +73,7 @@ Once this is finished, click the `Run` button at the bottom of the window, which
Make sure to take note of the custom Host port number you provide, as this will be needed later.
:::

## Running Your Application
## 3. Running Your Application

Once the container has been created, DWCJ applications can be run within the container instead of locally. First, it is necessary to configure
the POM file of your project correctly. Once this is done, going to a specific URL in the browser will show the application.
Expand Down
19 changes: 13 additions & 6 deletions docs/installation/local_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Installation will be broken down into the following steps:
4. Launching your application


## 1) Java and Maven Download and Configuration
## 1. Java and Maven Download and Configuration

In order to use the DWCJ, you must first have Java and Maven installed and properly configured. If you already
have Java and Maven downloaded, please skip to [**Step 2**](#section2). If you also have
Expand All @@ -45,7 +45,7 @@ for Windows users can be found [here](https://phoenixnap.com/kb/install-maven-wi

<a name='section2'></a>

## 2) BBj Download and Installation
## 2. BBj Download and Installation

<b>While following this step, be sure to install BBj version 22.14 or newer </b><br/><br/>

Expand All @@ -66,7 +66,7 @@ mvn install:install-file -Dfile=BBjUtil.jar -DgroupId=com.basis.lib -DartifactId

<a name='section3'></a>

## 3) Install and Configure the DWCJ Plugin
## 3. Install and Configure the DWCJ Plugin

Once BBj has been installed, we can access the Plugin Manager in order to install tools needed to configure the DWCJ. To start, type "Plugin Manager" into the start menu or Finder.

Expand All @@ -86,14 +86,21 @@ On this page, select the DWCJ entry, and click "Install".

Once this has been done, you should be able to switch back to the "Installed Plugins" tab, and see the DWCJ entry listed there.

Now that the plugin has been installed, navigate to the `bin` directory within your `bbx` folder and run the following command:
Finally, click on the "Configre" button, which will open a new window. In this window, click the "Enable Maven Remote Install" button.

![Enabling Remote Installation](./_images/users/local/i6.png)


:::tip

Alternatively, navigate to the `bin` directory within your `bbx` folder and run the following command:

```bbj
./bbj -tIO DWCJ/cli.bbj - enable_remote_install
```
:::


## 4) Clone the Repository
## 4. Clone the Repository

Once BBj and the required DWCJ plugin are installed and configured, we can clone the "Hello World" repository from the DWCJ Github page. This project comes with the necessary tools to run your first DWCJ program!

Expand Down
4 changes: 4 additions & 0 deletions docs/styling/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@ The `top` parameter accepts a boolean value, is false by default, and specifies

The `once` parameter accepts a boolean value, is false by default, and specifies whether the style should be injected into the page once only. This is useful when creating custom components that come with their own style sheets - multiple instances of the component can be used, but the style sheet will only be injected once.

:::tip Important!
In order to use the `once` parameter properly, ensure that you have also assigned a unique id using the `id` parameter.
:::

The `attributes` parameter is empty by default, and can be specified either as a string in the `attr=value,attr=value` format, or as a hashMap containing key/value pairs. These attributes are a set of [attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/style) to be added to the style element.

:::info
Expand Down

0 comments on commit cba2f38

Please sign in to comment.