Designing Wiki Output : Generating and Deploying Wiki Content
Generating and Deploying Wiki Content
Wiki content generation and deployment follows the same general process used to generate and deploy content using other format types that ePublisher supports, such as online help and PDF.
Use the following steps to help you understand this process:
1. Identify where you will deploy your Wiki content. For more information, see “Identifying Your Wiki Server and Wiki Output Format”.
2. Ensure that the Wiki where you will deploy your Wiki content is configured correctly. For more information about specific configuration requirements for the type of Wiki to which you plan to deploy content, see “Wiki - Confluence”, “Wiki - MediaWiki”, and “Wiki - MoinMoin”.
3. Identify an existing login on the Wiki that ePublisher can use when deploying content or create a new login on the Wiki for ePublisher to use to deploy content. For more information about creating a login on the Wiki, see the documentation for your Wiki server.
4. If you have an existing Stationery design project, add a target that uses the Wiki output format that you want to use for your existing Stationery design project. For more information, see “Adding Output Formats to Your Stationery Design Project” and “Adding a Target to Your Stationery Design Project”.
5. If you do not have an existing Stationery design project, create a new Stationery design project and add a target that uses the Wiki output format for your new Stationery design project. For more information, see “Creating a Stationery Design Project”, “Adding Output Formats to Your Stationery Design Project” and “Adding a Target to Your Stationery Design Project”.
6. Specify the appearance and other features you want your deployed Wiki content to have in the Wiki target in the Stationery design project. Ensure you define the following items for your Wiki target
*Page breaks. For more information, see “Defining New Pages (Page Breaks)”.
*TOCs and Mini-TOCs, including the appearance of mini-TOC elements. For more information, see “Defining TOCs and Mini-TOCs”.
*Appearance of paragraphs, lists, characters, images, pages, and links for Wiki output. For more information, see the following topics:
You can also choose to define output file names and specify categories for your Wiki pages using Adobe FrameMaker markers, Microsoft Word field codes, and @otherprops attributes from DITA, which come through as markers. For more information, see the following topics:
7. Specify target settings as appropriate.
For example, you can specify how you want to deploy baggage files, or files placed in the Files folder for the target. If you are generating and deploying MediaWiki output, you can specify if you want to use a prefix for each generated MediaWiki page.
For more information about specifying target settings for Wiki output, see “Specifying Output Format-Specific Settings”.
8. Create an output destination in ePublisher that specifies where you will deploy your generated Wiki output files.
Note: You must create a deployment point and deploy generated Wiki content before you can view the Wiki content.
For more information, see the following topics:
9. Generate output for your Wiki target. For more information, see “Generating Output”.
10. Deploy the Wiki output files to a Wiki server. For more information, see “Deploying Output to Output Destinations”.
Note: You must deploy generated Wiki content to a Wiki server before you can view the Wiki content.
11. Verify that your Wiki output has the appearance you want. Adjust settings in the Stationery design project as needed and then regenerate and deploy Wiki output files as needed until you obtain the look you want for your Wiki output.
12. Save your Stationery based on your Stationery design project and test the Stationery. Verify that the Wiki output files generated with the Stationery display appropriately on the Wiki server and in the appropriate location. For more information, see “Saving and Testing Stationery”.
13. Verify that users can access your deployed Wiki content from any landing pages you created on the Wiki that link to your generated Wiki output. For more information about landing pages, see “Creating Landing Pages”.
14. Distribute the Stationery that supports the appropriate Wiki output formats to content developers responsible for generating Wiki output. Also include the following information:
*Information about the Wiki servers, logins for ePublisher to use when deploying Wiki content, and locations on Wiki servers where they can deploy content.
*Information about any existing entry points on the Wiki for their content, as well as information about how they can create additional entry points for their Wiki content, if needed.
*Information about how the content deployed on a Wiki will be viewed, updated, and maintained after deployment.