LumiCode Web Publishing

Software development projects thrive on communication, and the diagrams and reports you produce with LumiCode are an important part of good communication. But to make those documents effective, you need to share them. That's where LumiCode Web Publishing comes in.

LumiCode Web Publishing converts your documents into a set of web pages with indexes and links to navigate between them. What you get is really a small website that's created automatically each time you click the Publish button! For a quick peek at what the web pages look like, click here.

LumiCode will automatically deploy these pages to a URL or shared network directory, making it easy to share your documents and keep them up to date.

All of this is done using only XSLT and XML technology, so you don't need to be running a particular web server, or any web server at all, for it to work.

Deployment methods

LumiCode has two different methods for deploying projects:

Network - This method will publish to a network directory.

FTP - This method will use FTP to publish to an internet location.

Publishing Setup

1. Under the Project menu, click Publish.

   

2. Enter a Project Name. This name will be used to identify the project on the Project Index web page.

3. Click Edit Settings.

   

4. Select a Deployment Method.

5. There is a settings tab for each deployment method, but only the one for the method you have chosen will be active.

6. Follow the directions below for the deployment method you have chosen.

Network deployment settings

Publish directory - Fully qualified path to the directory you want to publish to. This can be a UNC path, i.e \\ComputerName\Resource. You can use the Browse button to locate the directory.

FTP deployment settings

FTP Host - Domain name or IP Address of FTP host. Example: www.yourwebsite.com.

FTP Port - Port on FTP host. Defaults to port 21.

FTP Directory - Absolute path to the directory where the project index will reside on the remote site. Example: /yoursite/projects.

FTP User - FTP User Name.

Save password - If this is checked, the passwork is saved in the LumiCode configuration file. If unchecked, you will be prompted for a password each time you publish.

FTP Password - FTP Password. This item is disabled when Save password is unchecked.

Return URL

If you link to the LumiCode Web Publish index from your website, you may want to a link to return to your website. Enter the URL you want to return to, and a return link named Home will be appear on the generated web pages. If you leave this blank, Home will not appear.

Be sure to include the http:// at the beginning.

Publishing

1. Under the Project menu, click Publish.

2. Click the Publish button.

3. Enter a password if prompted for one (depends on the Save password setting), and then click OK.

4. The files will begin to upload and you will see the progress bar advance.

Your first publish will take the longer because everything need to be uploaded. After that, documents are time stamped and will be uploaded only if they have changed since the last publish.

Maintenance

• LumiCode Web Publishing does not include a way to remove projects. This is because of the potential for serious accidents if an incorrect directory path is specified.

• If you wish to remove a project, you must remove the directory for that project. The directory names will be of the form: lcproj_project name.

• If you are using Network deployment, you can use the Windows Explorer to delete a project directory.

• If you are using FTP deployment, use FTP commands or an FTP client application to delete a project directory.

• When the directory for a project has been deleted, it will no longer appear in the Project Index.