Document! X and HelpStudio 2021
Project Fundamentals / Working With Other Files
In This Topic
    Working With Other Files
    In This Topic

    In addition to the content you author, it is likely that your Document! X and HelpStudio project will contain one or more CSS stylesheet, image or script files. Document! X and HelpStudio includes a range of functionality to help you work with these Other Files.

    Other Files Fundamentals

    Add an existing image to the Project

    1. On the Project Ribbon Tab, click the Add existing Image file button;
    2. On the displayed file dialog, select the file or files to add to the project;
    3. The selected files will be added to the project and will then be available for selection in the Insert Image dialog.

     

    Capture a new Image

    1. Open the Image Capture tool by clicking on the Capture Image button on the Project Ribbon tab.
    2. Click the Capture button in the Image Capture dialog.

      The Image Capture tool allows you to choose when the capture will take place (Immediate, after a specified delay, or on a defined hotkey) and what the capture target is (whole screen, specific window, specific region etc).

      In this example the default options of Whole Screen and Immediate will be used.

    3. Click the Save button to save the captured image and complete the capture process.
      After capturing an image a preview will be displayed and options to change the filename, create a thumbnail, add a drop shadow and add the image to the currently open project.

     

    Edit an Image

    1. Select an image on the Project Explorer;
    2. Right click on the image to show the Context Menu;
    3. Select Edit Image from the Context Menu;
    4. The image will be opened for edit in the integrated Image Editor.

     

    Create a Thumbnail from a full size Image

    1. Select a full size image on the Project Explorer;
    2. Right click on the image to show the Context Menu;
    3. Select Create Thumbnail from the context menu.

     

    Add an existing StyleSheet to the project 

    1. On the Project Ribbon Tab, click the Add existing StyleSheet file button;
    2. On the displayed file dialog, select the file or files to add to the project;
    3. The selected files will be added to the project, included by default in each generated Topic and the styles contained within the stylesheet will be available for use on the Style Picker.

     

    Create a new StyleSheet

    1. On the Project Ribbon Tab, click the New StyleSheet button;
    2. When prompted, type the desired filename for the new StyleSheet;
    3. The new StyleSheet will then be created and opened for edit in the StyleSheet editor.

     

    Exclude Scripts or StyleSheets from a Topic

    By default, each Topic will automatically include all of the stylesheet and script files you add to the project. If you wish to prevent certain stylesheets or scripts being used in a particular topic you can do so by excluding them in the Properties editor:

    1. On the Project Explorer, select the Topic or Topics where you wish to prevent one or more stylesheets or scripts being included;
    2. In the Properties Window, click the button beside the Excluded Other Files property;
    3. On the displayed dialog, select the stylesheets or scripts that you don't want included;
    4. Click Ok.

     

    Exclude files from being included in the output

    Excluding a file from being included in any online output

    You may want to include some files only in booklet output (e.g. StyleSheets specific to booklet output).

    1. Select the file or files on the Project Explorer;
    2. In the Properties window, click on the Exclude from Online build flag in the Build Flag Picker at the top of the Properties editor;
    3. Files marked with the Exclude from Online flag will only be included in booklet output.

    Excluding a file from being included in any booklet output

    You may want to include some files only in online help output (e.g. StyleSheets specific to online output that you don't want used in booklet output).

    1. Select the file or files on the Project Explorer;
    2. In the Properties window, click on the Exclude from Booklet build flag in the Build Flag Picker at the top of the Properties editor;
    3. Files marked with the Exclude from Booklet flag will only be included in online output.

    Include or exclude a file for a particular Build Profile

    Using Build Flags you can create specific Rules in your Build Profiles that govern which files are included in which outputs.

    See the Single Sourcing topic for information on how to use Build Flags and Build Profiles to create multiple outputs containing different sets of files.

     

    Remove a file from the project

    1. Select the file or files you want to remove on the Project Explorer;
    2. Click the  Project Explorer toolbar button;
    3. The files will be removed from the project and you will prompted to confirm if you also wish to delete the files from disk.