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

Commit a9787e1

Browse files
committed
Updated README
1 parent 30cca61 commit a9787e1

2 files changed

Lines changed: 38 additions & 4 deletions

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,33 @@ When you first run the dashboard, you should go to the "Settings" tab to configu
7979
- 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.
8080
- Servers - Name, User, Password, Host, Port, Content Handler, Secure: 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. Set the "Secure" option if the specified port is an HTTPS port.
8181

82+
## Pushing Script Portlet Applications
83+
After setting a folder for Script Portlet applications in the settings tab, the
84+
toolkit provides a graphical interfaces for pushing script portlet applications.
85+
Pressing the "push" button will invoke the [`sp` command](http://www-01.ibm.com/support/knowledgecenter/SSHRKX_8.5.0/script/script-portlet/cmd_line_push_ovr.dita?lang=en) and push the
86+
application to the active server specified in the settings. If a `sp-config.json`
87+
file exists, it will be used when pushing the application. Pressing Tthe gear button
88+
will open a dialog for editing the application's `sp_config.json` file.
89+
90+
In the same dialog box (at the bottom), there is an option to set a pre-push command
91+
which can be used for minifying javascript, transpiling coffeescript, SASS, etc.,
92+
running a gulp or grunt build process, or launching other tools. This command will
93+
be run from the application's directory and will be run when pressing the push button
94+
or when the application's folder is being watched.
95+
96+
## Testing and Linting Script Portlet Applications
97+
Pressing the "SP Lint" button will run a linting utility for Script Portlet that
98+
will analyze the script portlet application and detect possible issues in the
99+
code where it is recommended to follow best practices.
100+
101+
Pressing the run button will runt the script portlet on a test server and open it
102+
in your browser. Although not complete, the test server locally simulates a Portal environment:
103+
- Common WCM tags are replaced with mock data. A complete list of tags that replaced
104+
with mock data can be found [here](https://github.com/OpenNTF/WebDevToolkitForDx/blob/master/digexp-sp-server/tag-replacements.json)
105+
- AJAX requests that use Portal's Ajax proxy will be sent through a local proxy.
106+
The test server supports the ResourceURL tag and URLs that use "/wps/proxy/"
107+
- Other tags are removed and won't appear in the html.
108+
82109
# Using the"dxwcmdesigns" command line utility
83110
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:
84111
```
@@ -172,4 +199,4 @@ There are some options that can be set to control some of the behavior when down
172199
- trial: if set any new features that have been added but not fully testes are added
173200
- include: This is an array of item types that allows you to limit the types of items that will be included in the pushed/pull actions for this library, this list will only support types that are handled by default. It allows you to limit the types to a subset of the supported types. i.e. Some one that only works on icons could limit it to "LibraryImageComponent"
174201

175-
To turn on the trial features for all libraries you can set an environment variable DIGEXP_TRIAL=true.
202+
To turn on the trial features for all libraries you can set an environment variable DIGEXP_TRIAL=true.

digexp-sp-server/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
# Simple test server for Script Portlet with mock implementations of WCM tags
22

3-
This is a simple implementation of a web server that provides mock implementations of portal-specific features. It provides simple removal or replacement of WCM tags. The list of tag substitutions comes from the tag-replacements.json file.
3+
This is a simple implementation of a web server that provides mock implementations
4+
of portal-specific features. It substitutes common WCM tags with mock data and
5+
removes others. The list of tag substitutions comes from the tag-replacements.json
6+
file. In addition, the server provides support for handling ResourceURL tags for
7+
generating urls for Portal's Ajax proxy.
48

5-
This test server is used by the Web Developer Dashboard part of this toolkit when you click the "Run" button for a script application. It's installed automatically when you install the dashboard, so typically you don't need to use the installation described below.
9+
This test server is used by the Web Developer Dashboard part of this toolkit when
10+
you click the "Run" button for a script application. It's installed automatically
11+
when you install the dashboard, so typically you don't need to use the installation
12+
described below.
613

714
## Installation
815
To install:
@@ -42,4 +49,4 @@ var serverInstance = spAppServer.start(spAppFolder, port);
4249
4350
// ... later, close the port when finished
4451
serverInstance.close();
45-
```
52+
```

0 commit comments

Comments
 (0)