Configure the Magellan Publishing Profile

Publishing

After importing the Magellan publishing profile into your Author-it library, you'll need to configure it before you can use it to publish to Magellan.

  1. Use Author to open the library you imported the Magellan publishing profile in to.

  2. Open the properties of the Magellan Help Center publishing profile.

  3. In the Actions tab, open the Compile Magellan Site After Publishing action.

  4. Modify the arguments field as required. You must include all elements.

    Sample argument:

    -WindowStyle Hidden -ExecutionPolicy bypass -File "C:\Program Files\Author-it\Compilers\Magellan\magellan.ps1" -PublishFolder "<SYS_PUBLISH_FOLDER>"-SaxonFolder "C:\Program Files\Saxonica\SaxonPE9.7N" -ResolvedXML "<SYS_PUBLISH_FILENAME>" -LocaleCode "<SYS_LOCALE_ABBREVIATION>" -MagellanFolder "C:\Program Files\Author-it\Engines\Magellan" -IndexerFolder "C:\Program Files\Author-it\Compilers\Magellan" -LibraryPath "C:\Author-it data\Data\Libraries" -ThemeFolder "C:\Author-it data\Data\Templates\Magellan Themes\(default)" -ContentFolder "en" -WebserverFolder "C:\inetpub\wwwroot\magellan\<SYS_PUBLISH_BOOK_ID>"

    Tip: Copy the Arguments field content to a text editor such as Notepad for easier editing.

  5. Click OK.

  6. Open the Open Magellan Output After Publishing action.

  7. Make sure URL location is selected and matches your specified WebserverFolder. For example, http://localhost/magellan/<SYS_PUBLISH_BOOK_ID>.

Arguments for the Compile Magellan Site After Publishing action of the Magellan publishing profile

Argument and default value

Explanation of the required value

-WindowStyle Hidden

The PowerShell script runs in the background without being displayed in a window. Do not edit.

-ExecutionPolicy bypass

This argument makes sure there are no Windows restrictions, so the script can run. There are no warnings or prompts. Do not edit.

-File "C:\Program Files\Author-it\Compilers\Magellan\magellan.ps1"

The location where the PowerShell script is located, and the filename - magellan.ps1. Change this location if your magellan.ps1 file is located elsewhere.

-PublishFolder "<SYS_PUBLISH_FOLDER>"

A system variable that will add the location of the published output to the argument. Do not edit.

-SaxonFolder "C:\Program Files\Saxonica\SaxonPE9.9N"

The location of the Saxon transformation tools for XML. Change this location if necessary, and check the version is correct.

This path is to the top level Saxon installation folder. The exe file is in a \bin subfolder, but the script will find it as long as that top-level folder is correct.

-ResolvedXML "<SYS_PUBLISH_FILENAME>"

A system variable that will add the filename of the published resolved XML to the argument. Do not edit.

-LocaleCode "<SYS_LOCALE_ABBREVIATION>"

A system variable that will add the two letter locale code for the language you are publishing to the argument.

-MagellanFolder "C:\Program Files\Author-it\Engines\Magellan"

The location of the Magellan Engine (the Framework). This folder is automatically created during the installation of Author-it On-Premises. Change this location if necessary.

-IndexerFolder "C:\Program Files\Author-it\Compilers\Magellan"

The location of the IndexerConfig.json file, which is in the same folder as the magellan.ps1 file. Change this location if necessary.

-LibraryPath "C:\Users\myaccount\Documents\Author-it Data\Libraries"

The folder path of your library. Change this location if necessary.

-ThemeFolder "\\myserver\Author-it Data\Templates\Magellan Themes\(default)"

The location of the Magellan Themes folders, which were installed with the other Magellan files. If these are located on a publishing server or common network share, this argument must point to that location. Change this location if necessary.

-ContentFolder "en"

The folder into which all the published Magellan output is copied. The default value is "en" but you can change it, especially if you are publishing to different languages.

The path to this folder is also specified in the siteconfig.json file, so if you use a different folder name or naming convention in the siteconfig, you must also change this argument to match the folder name in the siteconfig file.

If you are localizing your Magellan site, you'll probably want to change this to <SYS_LOCALE_ABBREVIATION>.

-WebserverFolder "C:\inetpub\wwwroot\magellan\<SYS_PUBLISH_BOOK_ID>"

Optional. Use this argument if you want to copy your published output directly into your webserver for viewing, or remove it if not required.

Note: If using this argument and the web server is located in C:\inetpub\, remove the User Access Control (UAC) from the inetpub folder so the publishing process can copy files to it.