You are here: Features > Output > Merging Projects > Merging Output at Runtime Using HTML5

Merging Output at Runtime Using HTML5

This is an easy way to merge the output from multiple HTML5 server-based Flare targets into one Help system. These targets can be originated from the same Flare project or from different Flare projects. You simply place the output files in the correct location on the server (i.e., within your master project's AutoMerge folder). Flare then automatically merges the output from all of the targets when users access the Help. From the end user's perspective, the results are seamless, appearing as one large Help system. All of the TOCs, browse sequences, indexes, glossaries, and search capabilities for the projects are merged.

For a complete scenario that illustrates these and other HTML5 server-based output steps in a real-life situation, see HTML5 Server-based Output Scenario.

Closedhow to merge output at runtime using html5
  1. Enable HTML5 Server-based Output If you want to take advantage of the advanced server-side features of HTML5 (i.e., automatic runtime project merging, server-side search, searching of non-XHTML files), you must enable HTML5 server-based output. This includes performing the following tasks: (1) installing Microsoft Internet Information Services (IIS) and ASP.NET, (2) setting up the HTML5 target and generating/publishing, (3) configuring IIS on the production server, (4) starting Microsoft Indexing Service or Microsoft Windows Search (depending on the operating system), and (5) enabling HTML5 search. See Enabling HTML5 Server-based Output.
  2. Determine Master Output Decide which of your project outputs will serve as the "master." This is the main output that users will open. All other outputs will be accessed from that output, although it will appear as one large Help system to end users.
  3. (Optional) Specify TOC and/or Browse Sequence Locations for Automerge By default, the TOCs and browse sequences from the secondary outputs will be appended at the end of the master output's TOC and browse sequence. However, if you want them to be appended somewhere within the master output's TOC or browse sequence, you can specify the exact location. See Specifying the Automerge Location in a TOC for HTML5 and Specifying the Automerge Location in a Browse Sequence for HTML5.
  4. (Optional) Specify Order of Merged Outputs When you automerge HTML5 outputs, the secondary outputs are merged to the master project's table of contents (TOC) and/or browse sequence in alphabetical order. However, you can override this default configuration and merge the secondary outputs in any order that you like. See Specifying the Order of Automerged HTML5 Outputs.
  5. Generate Outputs Build the output for each of the targets to be included in the automerge. You must use HTML5 for all of the targets. See Building Output.

  6. Publish Output to Server Publish the output for the master project to the web server running Microsoft IIS. The output files for the secondary targets need to be published to the "AutoMerge" subfolder located in the master target's main output folder (e.g., http://www.xyzincorporated.com/help systems/MyTargetName/AutoMerge). See Publishing Output to Destinations.

    When readers open the online output, they will see all of the HTML5 outputs merged into one Help system. They can easily navigate and use the index and search across all of the output files.

Closednotes

Note: If you are testing HTML5 server-based output on your local machine, you need view the output at least one time. When you view HTML5 output on your local computer, you need to create a special folder called "MCPreview" within your "C:\Inetpub\wwwroot" folder. Place a copy of your HTML5 output files in it. This enables you to test the advanced features of HTML5 on your local machine. (For Windows Vista users testing locally, the physical location is C:\MadCap\[Name of Project]\[Name of Main Entry File].htm.) When testing the automerge feature on your computer, you need to place the secondary ("child") outputs in the AutoMerge subfolder at this location (as opposed to the output folder that was generated where your Flare project is located).

Note: If you are testing HTML5 server-based output on your local machine, you may need to wait a few minutes after viewing the output for the Indexing Service to fully scan your files. Otherwise, you may not immediately see the effects of the scan (e.g., searches of non-XHTML files, incorporation of merged output files) in the output. If you avoid performing other tasks during this period, the scanning of the files will be completed more quickly.

Note: If you want to test HTML5 server-based output on your local computer,the advanced search features of HTML5 are not operable.

Note: Flare's HTML5 Top Navigation skin does not support project merging.