• Step 1: Installing Oxygen XML Author
  • Before diving into DITA authoring, ensure you have Oxygen XML Author installed on your system. You can download the software from the official https://www.oxygenxml.com/xml_author.htmlOxygen XML website.
• Step 2: Launching Oxygen XML Author
  • Once installed, launch Oxygen XML Author. You'll be greeted with a welcoming interface that provides a variety of options for your DITA authoring needs.
• Step 3: Creating a New DITA Topic
  • Navigate to the Menu:
    1. Select "File" from the top menu.
    2. Choose "New" and then "DITA" from the submenu.
    3. Click on "Topic."
  • Select DITA Topic Type:
    1. In the ensuing dialog, choose the type of DITA topic you want to create (e.g., Concept, Task, Reference).
    2. Click "Finish."
  • Authoring in the Editor:
    1. Oxygen XML Author opens a DITA topic in its editor.
    2. Start authoring your content using the DITA elements available in the toolbar.
    3. Leverage Oxygen's intelligent content completion and validation features to ensure adherence to DITA standards.
  • Save Your DITA Topic:
    1. Once you've crafted your DITA topic, save it by selecting "File" and then "Save" from the menu.
    2. Choose a location and provide a meaningful filename.
• Step 4: Creating Additional DITA Topics
  • Repeat the process outlined in Step 3 to create additional DITA topics for different sections or topics within your documentation. Oxygen XML Author streamlines the authoring process, allowing you to focus on content creation while ensuring DITA compliance.
• Step 5: Creating a DITA Map
  • Now that you've authored individual DITA topics, the next step is to organize them into a cohesive structure using a DITA map.
  • Navigate to the Menu:
    1. Select "File" from the top menu.
    2. Choose "New" and then "DITA" from the submenu.
    3. Click on "Map."
  • Add DITA Topics to the Map:
    1. Oxygen XML Author opens a blank DITA map in the editor.
    2. Drag and drop the previously created DITA topics from the Project view onto the DITA map.
    3. Arrange the topics in the desired order to reflect the structure of your documentation.
  • Create Map Hierarchy:
    1. Utilize the DITA map editor to create hierarchy and organization within your map.
    2. Right-click on the DITA map editor and choose options such as "Insert Topicref" to add references to your DITA topics.
  • Save Your DITA Map:
    1. Save the DITA map by selecting "File" and then "Save" from the menu.
    2. Provide a meaningful filename and choose an appropriate location.
• Step 6: Previewing Your Documentation
  • Oxygen XML Author enables you to preview your DITA documentation to ensure it appears as intended. Follow these steps:
  • Navigate to the Menu:
    1. Select "Document" from the top menu.
    2. Choose "Show Preview" to open a preview window.
  • Review the Preview:
    1. Oxygen XML Author generates a preview of your DITA documentation.
    2. Check the formatting, structure, and overall appearance to ensure it meets your expectations.
• Step 7: Fine-Tuning and Editing
  • Oxygen XML Author provides a host of features for fine-tuning and editing your DITA content. Explore the following functionalities:
  • Structured Editing:
    1. Leverage Oxygen's structured editing features to navigate and edit DITA elements easily.
    2. Use the Outline view to get an overview of the document structure.
  • Validation:
    1. Ensure your DITA content adheres to the DITA standard by utilizing Oxygen's validation features.
    2. Resolve any validation errors or warnings to maintain document integrity.
  • DITA Maps Manager:
    1. Access the DITA Maps Manager to visualize and manage the structure of your DITA map easily.
    2. Rearrange topics, add new references, or remove existing ones directly from the manager.
• Step 8: Generating Output
  • Once you are satisfied with your DITA documentation, Oxygen XML Author allows you to generate output in various formats, such as HTML, PDF, or others.
  • Navigate to the Menu:
    1. Select "Document" from the top menu.
    2. Choose "Transform" to access the transformation scenarios.
  • Choose Transformation Scenario:
    1. Select a predefined transformation scenario based on the output format you desire (e.g., HTML, PDF, etc.).
    2. Run the Transformation:
       • Click "Apply associated transformation scenario" to generate the output.
       • Oxygen XML Author processes your DITA documentation and produces the specified output format.
  • Review the Output:
    1. Open the generated output to review how your DITA documentation appears in its final form.
    2. Make any necessary adjustments or edits based on the output review.
• Step 9: Saving and Publishing
  • After generating the final output, save your work and proceed to publish your DITA documentation:
  • Save Your Changes:
    1. Save any edits or changes made during the preview and output generation.
  • Publishing Options:
    1. Depending on your publishing requirements, you can publish the documentation on a web server, share it internally, or distribute it through appropriate channels.
  • Distribute Your Documentation:
    1. Share the published documentation with your intended audience, whether it's internal teams, clients, or the wider public.

Conclusion: Mastering DITA Authoring with Oxygen XML Author Creating DITA topics and maps using Oxygen XML Author streamlines the authoring process, providing a user-friendly environment for structured content creation. By following this step-by-step guide, you can harness the power of DITA and Oxygen XML Author to produce well-organized, standards-compliant, and professionally presented technical documentation. Whether you are a seasoned technical writer or a newcomer to structured authoring, Oxygen XML Author's intuitive interface and robust features empower you to navigate the complexities of DITA with ease.