Sidebar Configuration¶
The sidebar configuration file configures the items available for interaction on the left side of Studio. The Sidebar shows different projections of the content in addition to other tools to assist in content authoring.
To modify the sidebar configuration, click on 
from the bottom of the Sidebar, then click on Configuration and select Sidebar Configuration from the dropdown list.
Sample¶
CRAFTER_HOME/data/repos/sites/SITENAME/sandbox/config/studio/context-nav/sidebar.xml¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | <?xml version="1.0" encoding="UTF-8"?>
<!-- sidebar.xml
This configuration file controls the SideBar in Crafter Studio. The SideBar is the left bar that shows
different projections of the content in addition to other tools to assist in content authoring.
<contextNav>
<modulehook>
<name>dashboard</name>
<params>
<label>Dashboard</label>
<path>/site-dashboard</path>
<icon> (optional icon customization - only one state (no tree link))
<class>fa-cog</class> (change default icon - using Font Awesome class)
<styles> (Change default icon styles - using css rules)
<color>#409a00</color>
<font-size>16px</font-size>
</styles>
</icon>
<roles>
<role>admin</role>
<role>developer</role>
</roles>
<label>Site Config</label>
<path>/site-config</path>
<showRootItem>true</showRootItem>
<onClick>preview</onClick>
</params>
</modulehook>
</contextNav>
<contextNav>
<modulehook>
<name>wcm-root-folder</name>
<showDivider>true</showDivider>
<label>Pages</label>
<path>/site/website</path>
<module-icon-open> (optional module-icon-open customization - state open)
<class>fa-cog</class>
<styles>
<color>#409a00</color>
<font-size>16px</font-size>
</styles>
</module-icon-open>
<module-icon-closed> (optional module-icon-closed customization - state close)
<class>fa-cog</class>
<styles>
<color>#409a00</color>
<font-size>16px</font-size>
</styles>
</module-icon-closed>
<showRootItem>true</showRootItem>
<onClick>preview</onClick>
</params>
</modulehook>
</contextNav>
Common module hooks include:
<modulehook>
<name>wcm-root-folder</name> Type: Browsable content tree of descriptors and folders
<showDivider>true</showDivider> Display a visual divider after the folder (true/false)
<params>
<label>Pages</label> Label
<path>/site/website</path> Path to root tree at. You mave multiple path elements
<showRootItem>true</showRootItem> Display the root folder (true/false)
<onClick>preview</onClick> Attempt to preview asset on click
<roles>...</roles> (optional roles list that has access to the menu item)
</params>
</modulehook>
<modulehook>
<name>wcm-asset-folder</name> Type: Browsable content tree of files and folders
<showDivider>true</showDivider> Display a visual divider after the foler (true/false)
<params>
<label>Static Assets</label> Label
<path>/static-assets</path> Path to root tree at. You mave multiple path elements
<showRootItem>true</showRootItem> Display the root folder (true/false)
<onClick>preview</onClick> Attempt to preview asset on click
<roles>...</roles> (optional roles list that has access to the menu item)
</params>
</modulehook>
<modulehook>
<name>dashboard</name> Type: Display a link to the Sites Dashboard
<params>
<label>Dashboard</label> Label
<path>/site-dashboard</path> Relative link to Sites Dashboard
<roles>...</roles> (optional roles list that has access to the menu item)
</params>
</modulehook>
<modulehook>
<name>site-config</name> Type: Display a link to the Site Config Panel
<params>
<label>Dashboard</label> Label
<path>/site-dashboard</path> Relative link to Site Config Panel
<roles>...</roles> (optional roles list that has access to the menu item)
</params>
</modulehook>
-->
<contextNav>
<contexts>
<context>
<groups>
<group>
<menuItems>
<menuItem>
<modulehooks>
<!-- Dashboard -->
<modulehook>
<name>dashboard</name>
<params>
<label>Dashboard</label>
<path>/site-dashboard</path>
</params>
</modulehook>
<!-- Site IA Pages -->
<modulehook>
<name>wcm-root-folder</name>
<params>
<label>Pages</label>
<path>/site/website</path>
<showRootItem>true</showRootItem>
<onClick>preview</onClick>
</params>
</modulehook>
<!-- Components -->
<modulehook>
<name>wcm-root-folder</name>
<params>
<label>Components</label>
<path>/site/components</path>
<showRootItem>true</showRootItem>
</params>
</modulehook>
<!-- Taxonomy -->
<modulehook>
<name>wcm-root-folder</name>
<params>
<label>Taxonomy</label>
<path>/site/taxonomy</path>
<showRootItem>true</showRootItem>
</params>
</modulehook>
<!-- Static Assets -->
<modulehook>
<name>wcm-assets-folder</name>
<params>
<label>Static Assets</label>
<path>/static-assets</path>
<showRootItem>true</showRootItem>
<onClick>none</onClick>
</params>
</modulehook>
<!-- Templates -->
<modulehook>
<name>wcm-assets-folder</name>
<params>
<label>Templates</label>
<path>/templates</path>
<showRootItem>true</showRootItem>
<onClick>none</onClick>
</params>
</modulehook>
<!-- Scripts -->
<modulehook>
<name>wcm-assets-folder</name>
<params>
<label>Scripts</label>
<path>/scripts</path>
<showRootItem>true</showRootItem>
<onClick>none</onClick>
</params>
</modulehook>
<!-- Site Config -->
<modulehook>
<name>site-config</name>
<params>
<roles>
<role>admin</role>
<role>developer</role>
</roles>
<label>Site Config</label>
<path>/site-config</path>
</params>
</modulehook>
</modulehooks>
</menuItem>
</menuItems>
</group>
</groups>
</context>
</contexts>
</contextNav>
|