Document! X and HelpStudio 2019
Authoring Content / Including Content from External Sources / Including Content from a Web Page
In This Topic
    Including Content from a Web Page
    In This Topic

    You can create Topics in your project that include content from Web Page. Including content from a Web Page rather than importing it is a good option when the content in the Web Page is managed outside of Document! X and HelpStudio and may be updated in future; the up to date content will be downloaded and included whenever you Preview a Topic or build the documentation.

    Using a Web Page as the source for a Topic in your help system allows you to re-use existing content that is managed externally without having to re-import each time the external content is updated.

    You may wish to import a static copy of the current content of a Web Page in your project rather than Including it; so that you can manage the content in Document! X and HelpStudio going forward. In order to import from a Web Page, first save a local copy of the page using the Save As command in your browser, and then import the saved Html document using the Html from file command on the Content Authoring Ribbon tab in the Topic or Content File editor.

    Importing creates a copy of the current content which can be edited in Document! X and HelpStudio. Subsequent changes to the Web Page will not be reflected in your project as they would if you choose to Include rather than import.

    Fundamentals

    To create a new Topic containing only content from a Web Page

    Create a new Topic

    In the banner displayed at the top of the Topic Editor, select Web Page from the drop down list.

    In the Source Uri field, type the fully qualified uri of the web page you wish to include.

    In the Tag Name, identify the HTML tag containing the content you wish to include. This field defaults to the BODY tag.

     - or -

    If you wish to include content from a specific element in the web page, specify the desired Element Id or Element Class.

    Tick the Create Local Images option if you would like local copies of an images included in the content to be created and used during the build process instead of the originally referenced image locations. This option ensures that the images in the generated output remain visible even if the original images are no longer available, or if the generated output is being viewed from an offline location.

    Include content from a Web Page in an existing Topic

    Open a Topic or Content File for edit.

    Position the cursor at the location at which you would like the content from a Web Page to be included.

    On the Content Authoring Ribbon Tab, click the Widget drop down and select the Content from Web Page widget.

    A Content from Web Page Widget will be inserted.

    In the Source Uri field, type the fully qualified uri of the web page you wish to include.

    In the Tag Name, identify the HTML tag containing the content you wish to include. This field defaults to the BODY tag.

     - or -

    If you wish to include content from a specific element in the web page, specify the desired Element Id or Element Class.

    Tick the Create Local Images option if you would like local copies of an images included in the content to be created and used during the build process instead of the originally referenced image locations. This option ensures that the images in the generated output remain visible even if the original images are no longer available, or if the generated output is being viewed from an offline location.

    In Preview and in the generated output, the latest content from the Web Page will be included in place of the Widget.

     

    See Also