Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

Commit dc5e20e

Browse files
committed
updates to names of commands
1 parent 400b217 commit dc5e20e

12 files changed

Lines changed: 20 additions & 19 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This project is an OpenNTF project, and is available under the Apache License V2
33

44
This toolkit includes two main areas of functionality:
55
- A "Web Developer Dashboard" that provides a user interface for working with Script Portlets, Portal themes, and WCM design elements. The theme support uses the Digital Experience File Sync tool under the covers. The Script Portlet support uses the Script Portlet command line support which must be installed separately on your workstation.
6-
- A command line tool "wcmdesigns" for moving WCM design elements - Presentation Templates and Components - between your local file system and your Portal server. This functionality is also available from the Dashboard.
6+
- A command line tool "dxwcmdesigns" for moving WCM design elements - Presentation Templates and Components - between your local file system and your Portal server. This functionality is also available from the Dashboard.
77

88
# Requirements
99
To use these tools you will need:
@@ -19,7 +19,8 @@ The Dashboard tool uses the nw.js package to implement the user interface, and o
1919
# Installation
2020
You must first install Node.js. Node.js version 0.12 is the tested and recommended version.
2121

22-
Download the digexp-toolkit.zip file in the release folder and unzip it on your workstation. Then run install.cmd (Windows) or install.sh (Mac/Linux). This will install the two main programs, digexp_dashboard (for the dashboard UI) and wcmdesigns (the command line support for accessing WCM design libraries). That completes the installation.
22+
Download the digexp-toolkit.zip file in the release folder and unzip it on your workstation. Then run install.cmd (Windows) or install.sh (Mac/Linux). This will install the two main programs, dxdashboard
23+
(for the dashboard UI) and dxwcmdesigns (the command line support for accessing WCM design libraries). That completes the installation.
2324

2425
For the Script Portlet "Push" support, you will need to have the Script Portlet command line client support installed and configured, and you will need to have the "sp" command on your system path. See this documentation for more on installing the Script Portlet command line client: http://www-01.ibm.com/support/knowledgecenter/SSHRKX_8.5.0/script/script-portlet/cmd_line_push.dita
2526

@@ -39,7 +40,7 @@ Key features:
3940
## Running the Web Developer Dashboard
4041
To launch the dashboard, run the following command:
4142
```
42-
digexp_dashboard
43+
dxdashboard
4344
```
4445

4546
When you first run the dashboard, you should go to the "Settings" tab to configure your file locations and Portal server settings.
@@ -48,18 +49,18 @@ When you first run the dashboard, you should go to the "Settings" tab to configu
4849
- WCM Design Folder: The parent folder for WCM design libraries. Each child folder represents one WCM library, with children for Components and Presentation Templates. To get any WCM library from the server, click the “Libraries” button.
4950
- Servers - Name, User, Password, Host, Port, Content Handler: Set these for your Portal server. You can have multiple server configurations and select the configuration to use. If you are using a Virtual Portal, include the Virtual Portal name as part of the "Content Handler" path, like this: /wps/mycontenthandler/my_vp_name.
5051

51-
# Using the"wcmdesigns" command line utility
52+
# Using the"dxwcmdesigns" command line utility
5253
Note that all the functionality for push/pull of WCM design files is available from the Dashboard user interface. For the command line support, use:
5354
```
54-
$ wcmdesigns <command> [options]
55+
$ dxdxwcmdesigns <command> [options]
5556
```
5657

5758
The commands are described below.
5859

5960
## init
6061
Usage:
6162
```
62-
$ wcmdesigns init [options]
63+
$ dxdxwcmdesigns init [options]
6364
```
6465
Running this command will display a prompt to select a WCM library. A subdirectory
6566
will be created (in the current working directory) and the selected library will be
@@ -74,7 +75,7 @@ The available options are:
7475
Usage:
7576
```
7677
$ cd <path to the wcm library>
77-
$ wcmdesigns push [options]
78+
$ dxdxwcmdesigns push [options]
7879
```
7980
Running this command will push the source files to WCM and update the library on the server.
8081

@@ -90,7 +91,7 @@ The available options are:
9091
Usage:
9192
```
9293
$ cd <path to the wcm library>
93-
$ wcmdesigns pull [options]
94+
$ dxdxwcmdesigns pull [options]
9495
```
9596
This command will download any remote changes to the WCM library. First run `wcm init`
9697
to initialize the WCM library before using `wcm pull`.

dashboard.tar.gz

5 Bytes
Binary file not shown.

digexp-dashboard/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "digexp-dashboard",
33
"description": "Web Developer Dashboard for IBM Digital Experience",
4-
"version": "0.0.1",
4+
"version": "0.1.0",
55
"main": "dashboard_index.html",
66
"bin": {
7-
"digexp_dashboard": "bin/digexp_dashboard"
7+
"dxdashboard": "bin/dxdashboard"
88
},
99
"window": {
1010
"show": true,
@@ -33,7 +33,7 @@
3333
"open": "^0.0.5",
3434
"request": "^2.58.0",
3535
"splint": "https://github.com/OpenNTF/Script-Portlet-Node-Samples/raw/master/splint.tgz",
36-
"tracer": "0.7.4",
36+
"tracer": "0.8.0",
3737
"vinyl": "^0.5.0",
3838
"vinyl-fs": "^1.0.0"
3939
},

digexp-sp-server/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name" : "ScriptAppServer",
3-
"version" : "0.0.2",
3+
"version" : "0.1.0",
44
"main": "./index.js",
55
"dependencies" : {
66
"express" : ">=3.x"

digexp-wcm-design/bin/dxwcmdesigns

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#! /usr/bin/env node
2+
require("../dxwcmdesigns.js");

digexp-wcm-design/bin/wcmdesigns

Lines changed: 0 additions & 2 deletions
This file was deleted.

digexp-wcm-design/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "digexp-wcm-design",
3-
"version": "0.0.1",
3+
"version": "0.1.0",
44
"description": "WCM Designs",
55
"main": "wcmHelper",
66
"bin": {
7-
"wcmdesigns": "bin/wcmdesigns"
7+
"dxwcmdesigns": "bin/dxwcmdesigns"
88
},
99
"dependencies": {
1010
"findit": "2.0.0",

digexp-wcm-design/wcmdesigns.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
88
* specific language governing permissions and limitations under the License.
99
*/
10-
process.title = "wcmdesigns";
10+
process.title = "dxwcmdesigns";
1111

1212
var argv;
1313
var utils = require('./lib/utils');
@@ -298,7 +298,7 @@ var pull = function(tries) {
298298

299299
switch (argv._[0]) {
300300
case undefined:
301-
console.log("Use 'wcmdesigns help' to view the available commands and options");
301+
console.log("Use 'dxwcmdesigns help' to view the available commands and options");
302302
yargs.showHelp();
303303
break;
304304
case "help":
@@ -315,7 +315,7 @@ switch (argv._[0]) {
315315
break;
316316
default:
317317
console.log("Command '%s' not recognized.", argv._[0]);
318-
console.log("Use 'wcmdesigns help' to view the available commands and options");
318+
console.log("Use 'dxwcmdesigns help' to view the available commands and options");
319319
}
320320

321321
function getInitPromptSchema(settings) {

release/digexp-toolkit.zip

3 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)