Breadcrumb Navigation

Transcription

1 User Guide QuePort Apps Breadcrumb Navigation Installation and Configuration Guide Page 1 of 15

2 Table of Contents 1. About My Breadcrumb Prerequisites and Requirements How to install and integrate the app How to install and integrate the app using the SharePoint Store How to integrate the app when the Publishing Feature is enabled How to add the App in a specific SharePoint Site Pricing Model Page 2 of 15

3 1. About My Breadcrumb In Grimm`s fairytale, Hansel and Gretel are taken deep into the forest by their parents. But Hansel left a trail of breadcrumbs in order to show their return path. Without the breadcrumbs, Hansel and Gretel would have never found their way back home. While the story inspired the term breadcrumb navigation, it also provides a metaphor to efficiently navigate through business applications. Most of us know the pain that comes from digging through SharePoint and navigate back to where you came from. That is why we developed the Breadcrumb Navigation App. We want to provide a way to quickly navigate through SharePoint Sites by flawlessly integrating a Breadcrumb navigation in the SharePoint suite bar. My Breadcrumb provides a trail for the SharePoint user to navigate to previous SharePoint. The sites are displayed in a hierarchical site structure. In that way users keep track of their locations within the deep SharePoint forest. The app also considers the site permission settings of the current user. 2. Prerequisites and Requirements Before you install and use My Breadcrumb, make sure the following prerequisites are met: SharePoint 2013 online and Office 365 respective is installed Google Chrome , Mozilla Firefox , or Internet Explorer 9 or above is installed on the server where you want to use this app. You have to be a tenant admin to add or give access to this app The SharePoint Site or SiteCollection where you want to install the Newsfeed Notifier is created Page 3 of 15

4 3. How to install and integrate the app The User Guide describes how to install My Breadcrumb in SharePoint Online. If you have a SharePoint on-premise environment please contact us. Chapter 3.1 focuses on installing the app via the SharePoint App Store. Please note that you have to follow a slightly different installation procedure when the Site Collection Publishing Infrastructure and SharePoint Server Publishing respectively is enabled (chapter 3.2) How to install and integrate the app using the SharePoint Store In general the user guide is divided in two parts. The first part describes the app installation per se that is explained in the steps 1 to 5. After successfully installing the app to your SharePoint environment, you can integrate the app either in all SharePoint sites or in a specific SharePoint site. We recommend to provide the app for Site Collections rather than a specific SharePoint site because you normally want to access your breadcrumb at any time. Steps 6-16 describe the approach to integrate the app in a whole Site Collection. Chapter 4 focusses on explaining the procedure of providing the app for a single SharePoint site. 1.) Go to your settings icon and click Add an app. Page 4 of 15

5 2.) Click on the SharePoint Store. 3.) If not done yet, please select your preferred language for the SharePoint Store in the right upper corner. 4.) Go to the search input field and search for My Breadcrumb. Page 5 of 15

6 5.) Select My Breadcrumbs and add it. Please note that the app is free for up to 5 users. For more information please visit our pricing page or contact us to get a specific offer. After successfully downloading the app to your SharePoint environment, you have to integrate the app in your suite bar by adapting the master page. For this you can either follow the steps below or click on Recent My Breadcrumb where you will get to the tutorial to integrate the app. Please note that the steps in the user guide and in the SharePoint tutorial page are the same. Page 6 of 15

7 6.) Go back to your TeamSite and click on the settings icon in the right upper corner. 7.) Click on Site settings. 8.) Click on Master Pages. Page 7 of 15

8 9.) Download your current master page. The default master is normally seattle.master. If you are not sure which master page is being used, please follow this link. Note: If you have SharePoint Designer, you can open the master file and directly edit the master file without the need to download a copy. 10.) Open the.master file with a notepad and paste the following snippet code below the closing head tag. <script id="qp_mybreadcrumb_bootcode" src=" oud.com/mybreadcrumb/boot/queport_mybreadcrumb_bootcode.js" type="tex t/javascript"></script> Page 8 of 15

9 11.) After inserting the snippet code, save the.master file and upload the file to the same directory (Site Settings Master pages Master Page Gallery). 12.) Press Save. Page 9 of 15

10 13.) Enjoy! 3.2. How to integrate the app when the Publishing Feature is enabled SharePoint Online includes a set of features to publish rich webpages for your intranet and internet. In this way you can inherit your corporate look and feel to site collections or sites. You can activate the publishing feature at either the site collection or site level. To properly integrate the app in your suite bar you normally have to adapt the.master. But in case you enabled the SharePoint Server Publishing Feature and the Site Collection Publishing Infrastructure, you have to adjust the html master page instead. To check whether you turned on the Server Publishing Feature for your Site Collection please follow the steps below: For a Site Collection: 1. From the root of your site collection, click Settings > Site settings. 2. On the Site Settings page under Site Collection Administration, click Site collection features. 3. On the Site Features page, scroll down to SharePoint Server Publishing Infrastructure and click Activate. Page 10 of 15

11 For a Site: 1. From any page within the site, click (gear icon) Settings > Site settings. 2. On the Site Settings page, in the Site Actions section, click Manage site features. 3. On the Site Features page, next to SharePoint Server Publishing, click Activate. If you enabled the publishing features, steps 1 to 11 are still the same. But instead of adjusting the.master file you have to adjust the.html master page. 12.) Go back to Site Settings Master pages and Page Layout Master Page Gallery and download the.html master page. The default master page is normally seattle.html. Note: If you have SharePoint Designer, you can open the html master file and directly edit the master file without the need to download a copy. Page 11 of 15

12 13.) Open the.master file with a notepad and paste the following snippet after the <body>-tag. <script id="qp_mybreadcrumb_bootcode" src=" m/mybreadcrumb/boot/queport_mybreadcrumb_bootcode.js" type="text/javascript "></script> 14.) After inserting the snippet code, save the.html file and upload it to the same directory (Site Settings Master pages Master Page Gallery). Page 12 of 15

13 15.) Press Save. 16.) Enjoy! Page 13 of 15

14 4. How to add the App in a specific SharePoint Site Please note that you cannot embed the code in the Master Page AND in a specific page. In case you already implemented the app in all SharePoint Sites you need to reverse step 13 and delete the embedded snippet code. Apart from that you need to follow step 1 to 12 described in chapter ) Navigate to the page you want to add the Newsfeed Notifier and click Page Edit in the left upper corner. 14.) Afterwards click on Insert Embed Code. 15.) Afterwards click on Insert Embed Code. <script id="qp_mybreadcrumb_bootcode" src=" m/mybreadcrumb/boot/queport_mybreadcrumb_bootcode.js" type="text/javascript "></script> Page 14 of 15

15 5. Pricing Model In general, the app is free for up to 5 SharePoint users. The price is graded and depends on amount of users. If you are interested in purchasing the app for more than 5 users, please go to our pricing page. When you installed the app we can simply unlock the number of users you need. Page 15 of 15