Publish your first document
The following procedure shows you how to add and publish a test document. This procedure provides you with a quick way to verify that you have correctly installed and configured the publishing components. For more details on adding and publishing documents through Workplace, refer to the Workplace help topic on how to manage a document.
Before you can publish a document, you must:
- Create folders for use by the publish template
- Create a publish template
For more information, refer to the Workplace help topic on the Publishing Designer.
To create folders to be used by publish templates
From the Content Engine (or an Enterprise Manager-only machine), do the following:
- Start Enterprise Manager and log on as an IBM FileNet P8 domain administrator.
- Navigate to the object store to be used for publishing and verify that the Publishing AddOn has been added to the object store.
- From the Root folder or other subfolder of the object store, create the following folders:
- Templates
- Documents
- Published
- Published\PDF
- Published\HTML
To create a publish template
- Sign in to Workplace as an IBM FileNet P8 domain administrator.
- Select Author, and then select Advanced Tools.
- Click Publishing Designer. At the Security dialog box, choose Always.
NOTE This dialog box only displays the first time you click Publishing Designer.
- From the Object Store to host publish operation using this template box, select the Publishing Object Store (or other object store to be used for publishing).
- From the Destination Folder object, click Browse, select the Published\PDF subfolder, and then click Select.
- Under Optional Settings, select Use a Style Template to transform the content, select Default PDF Style Template, and then click OK.
NOTE Depending on the style template you choose, you can create the other template after you finish the following procedures.
- Click Add New.
- Click Browse and navigate to the published document Templates folder.
- Click Select, and then click Next.
- Enter Publish Template Properties (Document Title and Description) and click Next.
- Verify the Security Settings and click Finish.
- Perform Step 4 through Step 11 for the HTML Publish Template.
NOTE In Step 5 and Step 6, be sure to browse to the Published\HTML subfolder and select the Default HTML Style Template.
- From the Publishing Designer, open the File menu, and then click Exit.
- Close your browser window.
To add and publish a test document
- Set the site preferences on Application Engine to use path-based URLs.
NOTE If you choose not to use path-based URLs, graphics and other internal references will not be resolved when viewing documents that have been published to HTML.
- Sign in to Workplace as a user assigned the Application Engine Administrators access role. (This is not a group, but an access role.)
- Choose Admin > Site Preferences.
- Under General Settings > Application section, set Use path based URLs to Yes.
- Click Apply to save the setting.
- Click Exit.
- Add a test document to publish.
- Open Workplace and sign in as FileNet P8 domain administrator.
- Select Author, and then select General Tools.
- Click Add Document.
- Click Publishing object store.
- Click the Documents subfolder.
- Click Next twice.
- Enter the Document Title and click Next.
NOTE If you do not enter the document title, Workplace will default to the file name.
- At the Security Settings dialog, click Next.
- Browse for the document and select Open, then click Finish.
- Click OK.
- Publish the test document, as follows:
- In Workplace under Browse, click the object store.
- Click the Documents folder.
- Right-click the document and select Publish.
- Click Publish New.
- Click Select under the PDF (or HTML) template.
- Click Next.
- Click Finish.
- Go to the destination folder you created and verify that the document was successfully published.
Publishing a DITA document
There are two ways that you can author DITA documents. You can use IBM FileNet Enterprise Manager or you can create a custom application.
Using Enterprise Manager to author DITA documents
In IBM FileNet Enterprise Manager you can create DITA topics and maps using the auto-classification option. This option allows you to define the relationships between the components. Use Enterprise Manager to create the topic files and the ditamap. After you have completed these tasks in Enterprise Manager, you can follow the steps outlined in Publishing your first document to publish the DITA document in Workplace.
To create the topic files
1. In Enterprise Manager, create a new folder in the Root folder. This new folder will hold your DITA topics and ditamap.
2. Within the new folder, create a new document.
3. Name the file. The name of the document has to be the same as the name of the file.
4. In the field Document MIME type, enter application/dita+xml
5. In the Advanced Features, select Automatically classify this document.
To create the ditamap
- Within the new folder, create a new document.
- Name the file with a ditamap extension for example, TC1.ditamap.
- In the field Document MIME type, enter application/dita+xml.
- In the Advanced Features, select Automatically classify this document.
- Finish the wizard and refresh the screen. In the view pane, you see all the topic files you've created along with the ditamap file. If there were topics in the ditamap that you had not created, the ditamap will create stubs for the topics and they will show up as yellow documents in the view pane.
- Be sure that the references (href) in the ditamap to topics provide a valid relative folder location and file name of the topic. The DITA auto-classification follows these relative folder locations in the href to find and create the topics.
- Select and check out each of the stub (yellow) files.
- Specify the mime type as application/dita+xml and check each file back in.
- Each file turns color from yellow to white when they are properly checked in.
- You can now publish the DITA document through Workplace.
Using custom applications to author DITA documents
You can write custom application software to define the component relationships between DITA topics and ditamaps. These components can then be published using Workplace or the FileNet P8 APIs.
NOTE Workplace XT does not support the publishing or authoring of DITA components