Site configuation elements explained - On Premises 6.4

Magellan

Most of the elements in the siteconfig.json file, which you may want to customize in your themeconfig.json file, have three settings of enabled, visible and defaultValue that can be set to true or false. For example:

"logo": {
"enabled": true,
"visible": true,
"defaultValue": true

Use the following two tables for information about:

  • the enabled, visible and defaultValue settings and how to use them,
  • what each element in the siteconfig.json file defines, with any additional settings.

Pro Tip: The JSON standard is a commonly-used data interchange format with a lot of freely available information to help your understanding. There are also dedicated JSON viewers and editors available, such as the Notepad++ JSON viewer plugin, which may make it easier to work in the JSON files - making the hierarchy more obvious, for example.

Use the different settings and values as follows.

True

False

enabled

The item can be switched ON or OFF in the settings menu (21 in image below).

The item is grayed out in the settings menu and its default value (ON or OFF) cannot be changed.

visible

The item is visible in the settings menu (21 in image below).

The item is not visible in the settings menu.

defaultValue

The item is visible in the site.

The item is not visible in the site.

Use the element descriptions and any additional settings, as follows.

Magellan content page with annotations3

Annotation

Element

Description and any additional settings

"title": "siteConfig",
"version": "20.3.2.1",
"appversion": "20.3.2",

Provides information about versioning etc.

Do not change

1

"navigation":

Displays or hides the navigation bar. Overrides defaultValue selections made for the "header" element.

  • Set to true to always display the navigation bar, or set to false to always hide the navigation bar.
  • Also set the "header" element below.

5

"disqus":

Defines your Disqus customer key, as acquired separately from Disqus.

  • Set to your customer key.

Also set the "disqus" element below.

"leftMenu": {
"max-width": "",
"min-width": ""
},
"rightMenu": {
"max-width": "",
"min-width": ""

These elements were used for earlier versions of Magellan to set the width and height of the navigation menu on the left and the widgets section menu on the right. You may still see them in your siteconfig.json file if you have not yet upgraded your installation.

In the latest version of Magellan these settings are now moved to and updated for responsive design in the mainstyles.css file. To customize this css file, see: Change Magellan css files.

"rtlCss": "css/bootstrap-rtl.min.css"

Calls the css for the support of Right To Left languages.

"imageClickPopOver":

Controls whether hovering over an image shows an expanded view.

  • Set to true (show expanded views) or false (do not show expanded views).

"searchResultSize":

Sets the number of search results shown per page. The default is 10.

  • Change the number as appropriate.

2

"share": {
"linkedin": true,
"facebook": true,
"twitter": true,
"email": true

Controls which social media icons appear in the Share menu.

  • Set a media to true to display or false to hide.
  • Set all to false to hide the Share option from the heading context menu.

Share menu

3

"footer": {
"landing": true,
"content": true

Controls whether the footer appears on the landing page and content page.

  • Set to true or false.

4

"scroll": {
"desktop": "infinite",
"mobile": "infinite"

Controls how the content pages scroll when viewing the site on two different device types - page by page or infinite scroll.

  • Set page or infinite.

5

"disqus": {
"enabled": true,
"visible": true,
"defaultValue": true

If the "disqus" element at the beginning of the file contains your Disqus customer key (acquired separately from Disqus), these selections will apply; but if it is empty, these settings will be invisible or disabled.

Controls the Disqus widget on the site and the Disqus option on the heading context menu.

  • Set enabled, visible and defaultValue as appropriate using the information above.

6

"favourites_pages": {
"enabled": true,
"visible": true,
"defaultValue": true

Controls the My Favourite Pages widget on the site and the Add to Favourites option on the heading context menu.

  • Set enabled, visible and defaultValue as appropriate using the information above.

7

"glossary":{
"enabled": true,
"visible": true,
"defaultValue": true

Controls whether the Glossary tab is shown or not.

  • Set enabled, visible and defaultValue as appropriate using the information above.

8

"hambuger_menu":{
"enabled": true,
"visible": true,
"defaultValue": true

Sets the default for showing or hiding the Hamburger menu, which controls the navigation menu containing the Table of Contents, Index and Glossary.

9

"header": {
"enabled": true,
"visible": true,
"defaultValue": true,
"showLevels": "1"

If the "navigation" element at the beginning of the file is set to true, these selections will apply; but if it is set to false, these settings will have no effect.

Controls the navigation bar across the top of the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.
  • In "showLevels" choose the number of heading levels to show on the navigation bar.

10

"index": {
"enabled": true,
"visible": true,
"defaultValue": true

Controls whether the Index tab is shown or not.

  • Set enabled, visible and defaultValue as appropriate using the information above.

11

"logo": {
"enabled": true,
"visible": true,
"defaultValue": true

Controls whether the logo is shown or not.

  • Set enabled, visible and defaultValue as appropriate using the information above.

12

"most searches": {
"enabled": true,
"visible": true,
"defaultValue": true

Controls the Most Recent Searches widget on the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.

13

"my_savedSearches":{
"enabled": true,
"visible": true,
"defaultValue": true

Controls the My Saved Searches widget on the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.

14

"recent pages":{
"enabled": true,
"visible": true,
"defaultValue": true

Controls the Recently Updated pages widget on the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.

15

"related links":{
"enabled": true,
"visible": true,
"defaultValue": true

Shows or hides the related topics links (as set in Related Topics in Author) on the topic heading.

  • Set enabled, visible and defaultValue as appropriate using the information above.

16

"resources": {
"enabled": true,
"visible": true,
"defaultValue": true

Controls the Resources widget on the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.

17

"section menu": {
"enabled": true,
"visible": true,
"defaultValue": true

Sets the default for showing or hiding the widgets section menu on the right.

  • Set enabled, visible and defaultValue as appropriate using the information above.

18

"toc": {
"enabled": true,
"visible": true,
"defaultValue": true,
"expanded": false,
"showLevels": "4",
"contextMenuLevels": "all"

Controls the Table of Contents (TOC).

  • Set enabled, visible and defaultValue as appropriate using the information above to show or hide the TOC.
  • expanded - choose if the TOC is collapsed or expanded on site opening. Enter true (expanded) or false (collapsed).
  • show levels - enter the number of heading levels to show. Enter a number or "all". If you enter 0, the default of "all" is applied.
  • ContextMenuLevels - sets which heading levels show a context menu (22 in image). Enter a number or "all".

19

"translate":{
"enabled": true,
"visible": true,
"defaultValue": true

This element is designed for configuring automatic translation of your Magellan site using the Google translation API with a purchased API key.

This Magellan feature is currently in Beta and will be fully supported in a future release.

20

"what_section":{
"enabled": true,
"visible": true,
"defaultValue": true

Controls the What`s in this section widget on the site.

  • Set enabled, visible and defaultValue as appropriate using the information above.

19

"Filter":

Controls the languages that appear on the language selector menu, and filters for a mutli-publication sites.

  • Set enabled, visible and defaultValue as appropriate using the information above.
  • For more information about defining language filters, see: Setting the filter.