MNP 2.0 SDK - DOC

Document Sample
MNP 2.0 SDK - DOC Powered By Docstoc
					Microsoft Network Project v2.5


MNP Rendering Templates SDK

                                                                                                st
                                                                                       March 31 , 2003




                                                                              Primary Contact: Lori Niva
                                                                         Secondary Contact: Bret Mulvey

                                Document Authors and Contributors:
                                    Bret Mulvey, - Development
                                  Lori Niva– Program Management
                                   Ryan Farber, Peter Bate - Test




    Document Purpose:
    The purpose of this document is to outline the steps to use the Microsoft
    Network Project (MNP) 2.5 Rendering Templates. This document provides
    an overview of what the features are and contains specific details about
    functionality for leveraging and deploying these features.




    This document is strictly Microsoft Confidential and is not to be shared with anyone outside the
    company unless under Microsoft NDA.
                                               TABLE OF CONTENTS
1. GENERAL PROJECT INFORMATION ................................................................................. 3
    1.1.        REVISION HISTORY ......................................................................................... 3
    1.2.        RELATED DOCUMENT INFORMATION ................................................................. 3
2. INTRODUCTION............................................................................................................. 4
    2.1.        OVERVIEW AND BACKGROUND ......................................................................... 4
3. PRE-REQUISITIS............................................................................................................ 4
    3.1.        GETTING HELP .................................................................................................. 4
4. EASY USER GUIDE TO MNP 2.5 RENDERING TEMPLATES ................................................... 4
5. TEMPLATE INFORMATIONERROR! BOOKMARK NOT DEFINED.ERROR! BOOKMARK NOT DEFINED.
6. BROWSER SUPPORT ..................................................................................................... 6
7. MNP EXTENSIONS TO XSLT FOR TEMPLATE AUTHORSERROR! BOOKMARK NOT DEFINED.ERROR! BOOKMAR




              CONFIDENTIAL                              PAGE 2             5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC
1. GENERAL PROJECT INFORMATION

   1.1.       REVISION HISTORY

 Author               Date        Comments
 Lori Niva            3/21/2003   First Draft of Documentation.




   1.2.       RELATED DOCUMENT INFORMATION

 Location
 MNP Customerweb Site
 MNP Schema Information and sample files
 MNP Usage Guidelines Site
 MNP 2.5 SDK
 MNP Dev Guide




             CONFIDENTIAL                     PAGE 3              5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC
 2. INTRODUCTION

       2.1.    OVERVIEW AND BACKGROUND
 Each MNP template corresponds to a specific content type and primary customer need and accordingly meets
 specific and carefully defined objectives and requirements, from which consistent content frameworks and
 XML schemas have been derived. All are part of an overarching editorial and design system for content-type
 definition and display across Microsoft.com


 3. Pre-requisites

 The MNP 2.5 Rendering Templates DO require a Medium level of XML skills. The skill level required will
 depend on how far from the basic implementation you will be moving.

The following must be completed, and the user must have basic knowledge of technologies listed
below:

        MNP 2.5 bits installed on site or dev server where templates are being created.
        User has successfully completed and understands the process to create an MNP sample site and
         pages that are functioning properly and/or your own xml MNP pages are functioning correctly.
        Basic XML knowledge of XML fundamentals - XML tags, case sensitivity, closing tags, etc. <add link to
         article on XML basics page on customerweb>

       3.1.    Getting Help
 If you have questions or concerns while using this SDK, an alias has been set up for users of MNP to help
 each other help themselves. MNP Program Managers, Planners and Developers will also be on this alias to
 offer guidance where applicable. You can join “MNPhelp” by visiting
 http://Autodl/JoinDL.asp?DLAlias=mnphelp

 For general questions on MAT Projects & Services, please contact mailto:MSCOMHLP


 4. Easy User Guide to MNP 2.5 Rendering Templates

Complete the following steps to start creating XML content files against the MNP Rendering
Templates:

1) Copy Gallery folder
     Copy the \\internet-build1\drop\library\gallery folder to your development server/site

2) Edit your MNP.config file to point to MNP template folder –
MNP Template Folder name: /library/gallery/templates

Here is an example of an MNP.config file with the reference to the MNP template folder added in
bold:

<?xml version='1.0'?>
<configuration>




              CONFIDENTIAL                      PAGE 4         5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC
       <tableOfContents assembly="MNP.TableOfContents, Version=2.0.0.0, Culture=neutral,
PublicKeyToken=a75671c2b10b8543"
type="Microsoft.MSCOM.MNP.TableOfContents.XmlTableOfContents">
              <XmlTableOfContents>/mysite/tableOfContents.xml</XmlTableOfContents>
       </tableOfContents>
       <content>
              <register protocol="file" assembly="MNP.Content, Version=2.0.0.0,
Culture=neutral, PublicKeyToken=a75671c2b10b8543"
type="Microsoft.MSCOM.MNP.Content.FileContent" />
       </content>
       <templates>
              <folder>/mysite/templates</folder>
              <folder>/library/gallery/templates</folder>
       </templates>
</configuration>

Note: You can have multiple folders listed here for other templates in use.

3) Review MNP sample XML files
    Go to http://customerweb/mnp/schemas to view sample xml files for each template.
    Note: if you are using an xml authoring tool that does XSD validation, the MNP XSD's are
      located http://customerweb/mnp/schemas .

If you want to use MNP's validation tool
View the Readme for instructions on installing this tool to your local machine -
http://customerweb/mnp/schemas/mnp_templatevalidation_tool


4) Start authoring XML content
    Create a content xml file that follows MNP schema
    Put xml file entry in your TOC file as noted in MNP 2.5 SDK.

Here is an example of a simple page using the Generic Article template:

<?xml version="1.0" encoding="UTF-8"?>
<content type="MNP2.GenericArticle" xmlns="http://www.microsoft.com/MSCOM/MNP2/Schemas">
       <head>
              <meta name="pageTitle" content="Lorem Ipsum Dolor Sit Amet Consectetuer" />
              <meta name="description" content="This is the meta description of the page."
/>
              <meta name="keywords" content="key, word, MNP, generic article" />
              <meta name="publishedDate" content="2000-10-23" />
              <meta name="updatedDate" content="2002-03-05" />
       </head>
       <body>
              <section>
                     <title>Proin Aliquam Egestas Elit</title>
                     <para>Vivamus tempor sollicitudin elit. Aliquam a risus non nunc
tincidunt iaculis. Vivamus non erat sit amet purus facilisis pulvinar. Nullam quis augue
vel neque sollicitudin placerat. Donec eu libero. Phasellus vitae massa at dui convallis
dignissim. Nam scelerisque elementum mi. Nulla pulvinar pede non purus. In iaculis sodales
dolor.</para>
              </section>




           CONFIDENTIAL                    PAGE 5        5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC
              <relatedLinks>
                     <link xlinkHref="mnp:02C94E30-0266-926D-1E12-87F385DEF051" />
                     <link xlinkHref="mnp:CE73F8D3-38E7-8479-E4B8-3492C7B6A857" />
                     <link xlinkHref="mnp:7DC09CFE-3315-B8D5-EC9E-C3A647B61E31" />
              </relatedLinks>
       </body>
</content>


 5. Browser Support


MNP 2.5 supports the following browsers:

WebMetrix browser share information on WWW for Q102 has been added to the row and column titles for
reference. These percentages also align closely with independent data collected at
http://www.upsdell.com/BrowserNews/stat.htm (Source 1 most closely matches our audience). Testing will
concentrate testing on the higher (5% or greater) percentage browsers and platforms and run sanity tests on
any platform or browser containing 1% or more of the share.

    Browser        WinME (53%)      Win98     Win2000 (17%)    Win XP       NT 4.0      Win95        Mac
                                 (in WinMe)                    (13%)         (7%)       (4%)         (1%)
 IE 6.0 (32%)        Uplevel      Uplevel        Uplevel       Uplevel       NA          NA           NA
 IE 5.5 (26%)        Uplevel      Uplevel        Uplevel       Uplevel     Uplevel     Uplevel        NA
 IE 5.0 (33%)       Downlevel    Downlevel     Downlevel      Downlevel   Downlevel   Downlevel    Downlevel
 NS 4.0 (5%)        Downlevel    Downlevel     Downlevel      Downlevel   Downlevel   Downlevel    Downlevel
 IE 4.0 (2%)        Downlevel    Downlevel     Downlevel      Downlevel   Downlevel   Downlevel    Downlevel
 NS 6.2 (1%)           NA           NA             NA            NA          NA          NA           NA


Essentially IE 5.5 and above are up-level browsers.

The UI has been optimized for 800x600 resolution.


 6. Localization

Each MNP template has an XML file associated with it that contains localized strings, string
formats and date formats. For example, the localized resource files for the Generic Article
template can be found in the \\internet-
build1\drop\library\gallery\templates\MNP2.GenericArticle folder.

If you are adopting an MNP template and the template resource file is not provided for the
language and region that your site is designed for, you can localize this file yourself and send the
updated file to the MNP team to be published on the servers.

Here is an example of one of these files. The strings that should be localized are in bold—the
remainder of the file must remain unchanged when the file is localized:

<?xml version="1.0" encoding="utf-8" ?>
<resources locale="en-us" template="MNP2.GenericNav">
       <strings>
              <string id="onThisPage">On This Page</string>




                CONFIDENTIAL                     PAGE 6          5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC
              <string id="topOfPage">Top of page</string>
       </strings>
</resources>

The “encoding” value can be any valid XML encoding. This value does not affect the final output
of the template, but be sure that if the XML file is saved using an encoding other than UTF-8 that
the XML encoding value is set correctly. UTF-8 is recommended, however, as it should work for
all languages. The final HTML content is automatically sent to the browser using an encoding that
is optimal for each language.

The “id” attribute values must not be modified, but the strings inside the <string> elements
should be translated.

Some templates include string formatting parameters. For example, the Generic Article template
has the following entry:

               <string id="publishedFormat">Published: {0}</string>

The {0} portion of this string is a placeholder that MNP fills in with the actual value to be
displayed. The use of placeholders makes it possible to localize the order in which the values
occur in relationship to the labels which are associated with them. In this example, if the
localized version of the “published” date should appear before the “Published:” label, the order
can be modified by changing the string format to:

               <string id="publishedFormat">{0} :Published</string>

Some templates include date-formatting parameters. For example, Generic Article contains

               <string id="dateFormat">MMMM d, yyyy</string>

This parameter indicates the format of dates that appear on the page. In this example, the full
month name appears first, followed by the day of the month, followed by a comma and the four-
digit year, e.g. March 24, 2003. To localize this so that dates show up as 24 Mar 2003 the
date formatting string would be

               <string id="dateFormat"> d MMM yyyy</string>




           CONFIDENTIAL                   PAGE 7         5D688D7B-07C7-4E4F-BA34-4595C94560F5.DOC

				
DOCUMENT INFO