Nawigacja serwisu

Hierarchiczna struktura serwisu jest przechowywana w pliku structure.json powiązanym z serwisem. Jest ładowana do pamięci i udostępniana w kontekście strony jako obiekt SCS.structureMap.

Narzędzie konstruktor serwisów odczytuje plik structure.json w celu narysowania drzewa serwisu. Kod stron serwisu będzie zawarty w pliku structure.json. Na przykład:

"pages": [  {        
     "id": 100,      
     "name": "Home",                                    
     "parentId": null,             
     "pageUrl": "index.html",      
     "hideInNavigation": false,    
     "linkUrl": "",                
     "linkTarget": "",             
     "children": [ 200,            
                   300,            
                   400,            
                   500 ],          
     "overrideUrl":false           
     } 
   
     {
     "id":200,
     "name":"Products"
     "parentId":100,                
     "hideInNavigation":false,      
     "LinkUrl":"",                  
                 "linkTarget":"",               
                 "children":[ 204, 205],        
                 "overrideUrl":false            
     }                              

     {
     "id":204,
     "name":"Hiking Boots",
     "parentId":200,
                 "pageUrl":"products/hiking_boots.html",
                 "hideInNavigation":false,
                 "linkUrl":"",
     "linkTarger":"",
     "children":[],
     "overrideUrl":false
     }

Kod JavaScript nawigacji jest niezbędny w ramach stron serwisu także do odczytania struktury serwisu i wyznaczenia odpowiednich łączy. W szablonach, dostarczanych z Oracle Content Management, są zawarte przykładowe pliki JavaScript nawigacji pokazujące, jak to działa.

Plik topnav.js, używany w niektórych motywach dostarczanych z Oracle Content Management, stanowi przykład prezentujący, w jaki sposób można używać obiektu SCS.structureMap wraz z wywołaniami Render API (takimi jak SCSRenderAPI.getPageLinkData) do przechodzenia po strukturze serwisu i wyznaczania kodu HTML, niezbędnego do renderowania — na stronie — menu nawigacji. Poniżej jest pokazany kod z przykładowego pliku topnav.js:

function renderNode(id, navBar)
{
        if (id >= 0)
        {
                var navNode = SCS.structureMap[id];
                if( navNode &&
                        (
                                ( typeof navNode.hideInNavigation != "boolean" ) ||
                                ( navNode.hideInNavigation === false )
                        ) )
                {
                        var navItem = document.createElement("li");
                        var navLink = document.createElement("a");
                        var navText = document.createTextNode(navNode.name);
                        
                        var linkData = SCSRenderAPI.getPageLinkData(navNode.id) || {};
                        if( linkData.href ) {
                                navLink.href = linkData.href;
                        }
                        if( linkData.target ) {
                                navLink.target = linkData.target;
                        }

                        navLink.appendChild(navText);
                        navItem.appendChild(navLink);

                        if (navNode.children.length > 0)
                        {
                                var navSub = document.createElement("ul");
                                
                                for (var c = 0; c < navNode.children.length; c++)
                                {
                                        renderNode(navNode.children[c], navSub);
                                }
                                
                                navItem.appendChild(navSub);
                        }
                        navBar.appendChild(navItem);
                }
        }
}

function renderNav()
{
        var topnav = document.getElementById("topnav");         // expected to be an empty <div>

        if (topnav)
        {
                var navBar = document.createElement("ul");

                renderNode(SCS.navigationRoot, navBar);

                topnav.appendChild(navBar);
        }
}

// Must wait for all our script to be ready...
if (document.addEventListener)
{
        document.addEventListener('scsrenderstart', renderNav, false); 
}
else if (document.attachEvent)
{
        document.documentElement.scsrenderstart = 0;
        document.documentElement.attachEvent("onpropertychange",
                function(event)
                {
                        if (event && (event.propertyName == "scsrenderstart"))
                        {
                                renderNav();
                        }
                }
        );
}

Korzystając z Render API, można generować łącza nawigacyjne, które będą funkcjonować w trybach edycji i podglądu serwisu, a także w opublikowanym serwisie online. Zob. Render API — opis.

Dobrą praktyką jest umieszczanie informacji nawigacyjnych w jednym pliku JavaScript, takim jak topnav.js. Plik JavaScript zazwyczaj jest przechowywany w katalogu /assets/js/ motywu, jak pokazano w przykładowych motywach dostarczanych z Oracle Content Management.