1 programming windows help shane mcroberts group program manager microsoft corporation...

1

Programming Windows Help

Shane McRoberts Group Program ManagerMicrosoft [email protected]

Session Code: CLI309

2

Tools

Client Application Model

Avalon Windows Forms

Web & Service Application Model

ASP.NET / Indigo Win FSCompact

FrameworkYukon Mobile PC Optimized

System.HelpSystem.Help

System.DrawingSystem.Drawing

System.NaturalLanguageServicesSystem.NaturalLanguageServices

Data Systems Application Model

Presentation Data

Mobile PC & Devices Application Model

Communication

Command Line

NT Service

DataSetDataSet

MappingMapping

ObjectSpacesObjectSpaces

ObjectSpaceObjectSpace

QueryQuery

SchemaSchema

ItemItem

RelationshipRelationship

MediaMedia

AudioAudio

VideoVideo

ImagesImages

System.MessagingSystem.Messaging System.DiscoverySystem.Discovery

System.DirectoryServicesSystem.DirectoryServices

System.RemotingSystem.Remoting

System.Runtime.RemotingSystem.Runtime.Remoting

ActiveDirectoryActiveDirectory

UddiUddi

System.Web.ServicesSystem.Web.Services

Web.ServiceWeb.Service

DescriptionDescription

DiscoveryDiscovery

ProtocolsProtocols

System.MessageBusSystem.MessageBus

TransportTransport

PortPort

ChannelChannel

ServiceService

QueueQueue

PubSubPubSub

RouterRouter

System.TimersSystem.Timers

System.GlobalizationSystem.Globalization

System.SerializationSystem.Serialization

System.ThreadingSystem.Threading

System.TextSystem.Text

System.DesignSystem.Design

Base & Application Services

Fundamentals

System.ComponentModelSystem.ComponentModel

System.CodeDomSystem.CodeDom

System.ReflectionSystem.Reflection

System.EnterpriseServicesSystem.EnterpriseServices

System.TransactionsSystem.Transactions

Security

System.Windows.TrustManagementSystem.Windows.TrustManagement

System.Web.SecuritySystem.Web.Security

System.MessageBus.SecuritySystem.MessageBus.Security

AuthorizationAuthorization

AccessControlAccessControl

CredentialsCredentials

CryptographyCryptography

System.Web.ConfigurationSystem.Web.Configuration

System.MessageBus.ConfigurationSystem.MessageBus.Configuration

System.ConfigurationSystem.Configuration

System.ResourcesSystem.ResourcesSystem.ManagementSystem.Management

System.DeploymentSystem.Deployment

System.DiagnosticsSystem.Diagnostics

Configuration Deployment/Management

System.WindowsSystem.Windows System.WindowsSystem.WindowsSystem.Windows.FormsSystem.Windows.Forms

System.ConsoleSystem.Console

System.ServiceProcessSystem.ServiceProcess

System.Windows.FormsSystem.Windows.Forms System.WebSystem.Web System.StorageSystem.Storage System.Data.SqlServ

erSystem.Data.SqlServer

AnimationAnimation

ControlsControls

ControlControl

DesignDesign

PanelPanel

ControlsControls

DialogsDialogs

SideBarSideBar

NotificationNotification

System.WindowsSystem.Windows

DocumentsDocuments

Text ElementText Element

ShapesShapes

ShapeShape

InkInk

UI ElementUI Element ExplorerExplorer MediaMedia

System.Windows.FormsSystem.Windows.Forms

FormsForms

ControlControl

Print DialogPrint Dialog

DesignDesign

System.Web.UISystem.Web.UI

PagePage

ControlControl

HtmlControlsHtmlControls

MobileControlsMobileControls

WebControlsWebControls

AdaptorsAdaptors

DesignDesign

PortsPorts

InteropServicesInteropServices

System.RuntimeSystem.Runtime

System.IOSystem.IO

System.CollectionsSystem.Collections

GenericGeneric

System.SearchSystem.Search

AnnotationsAnnotations

MonitoringMonitoring

LoggingLogging

RelevanceRelevance

System.DataSystem.Data

SqlClientSqlClient

SqlTypesSqlTypes

SqlXMLSqlXML

OdbcClientOdbcClient

OleDbClientOleDbClient

OracleClientOracleClient

CoreCore

ContactContact

LocationLocation

MessageMessage

DocumentDocument

EventEvent

System.StorageSystem.Storage

System.WebSystem.Web

PersonalizationPersonalization

CachingCaching

SessionStateSessionState

System.XmlSystem.Xml

SchemaSchema

SerializationSerialization

XpathXpath

QueryQuery

PermissionsPermissions

PolicyPolicy

PrincipalPrincipal

TokenToken

System.SecuritySystem.Security

System.CollaborationSystem.Collaboration

RealTimeEndpointRealTimeEndpoint

TransientDataSessionTransientDataSession

SignalingSessionSignalingSession

MediaMedia

ActivitiesActivities

HttpWebRequestHttpWebRequest

FtpWebListenerFtpWebListener

SslClientStreamSslClientStream

WebClientWebClient

System.NetSystem.Net

NetworkInformationNetworkInformation

SocketsSockets

CacheCache


AdministrationAdministration

ManagementManagement

NavigationNavigation

Peer GroupPeer Group

PolicyPolicy


CompilerServicesCompilerServices

RecognitionRecognition

System.SpeechSystem.Speech

SynthesisSynthesis

3

Tools







Data


Communication

Command Line

NT Service

DataSetDataSet

MappingMapping



QueryQuery

SchemaSchema

ItemItem


MediaMedia

AudioAudio

VideoVideo

ImagesImages






UddiUddi




DiscoveryDiscovery

ProtocolsProtocols


TransportTransport

PortPort

ChannelChannel

ServiceService

QueueQueue

PubSubPubSub

RouterRouter








Fundamentals






Security




















PortsPorts



System.IOSystem.IO


GenericGeneric




LoggingLogging

RelevanceRelevance


SqlClientSqlClient

SqlTypesSqlTypes

SqlXMLSqlXML




CoreCore

ContactContact

LocationLocation

MessageMessage

DocumentDocument

EventEvent




CachingCaching



SchemaSchema


XpathXpath

QueryQuery


PolicyPolicy

PrincipalPrincipal

TokenToken






MediaMedia





WebClientWebClient



SocketsSockets

CacheCache





PolicyPolicy






Presentation

AnimationAnimation

ControlsControls

ControlControl

DesignDesign

PanelPanel

ControlsControls

DialogsDialogs

SideBarSideBar



DocumentsDocuments


ShapesShapes

ShapeShape

InkInk



FormsForms

ControlControl


DesignDesign


PagePage

ControlControl




AdaptorsAdaptors

DesignDesign




SynthesisSynthesis

4

Tools










Presentation Data


Communication

Command Line

NT Service

DataSetDataSet

MappingMapping



QueryQuery

SchemaSchema

ItemItem


MediaMedia

AudioAudio

VideoVideo

ImagesImages






UddiUddi




DiscoveryDiscovery

ProtocolsProtocols


TransportTransport

PortPort

ChannelChannel

ServiceService

QueueQueue

PubSubPubSub

RouterRouter








Fundamentals






Security




















AnimationAnimation

ControlsControls

ControlControl

DesignDesign

PanelPanel

ControlsControls

DialogsDialogs

SideBarSideBar



DocumentsDocuments


ShapesShapes

ShapeShape

InkInk



FormsForms

ControlControl


DesignDesign


PagePage

ControlControl




AdaptorsAdaptors

DesignDesign

PortsPorts



System.IOSystem.IO


GenericGeneric




LoggingLogging

RelevanceRelevance


SqlClientSqlClient

SqlTypesSqlTypes

SqlXMLSqlXML




CoreCore

ContactContact

LocationLocation

MessageMessage

DocumentDocument

EventEvent




CachingCaching



SchemaSchema


XpathXpath

QueryQuery


PolicyPolicy

PrincipalPrincipal

TokenToken






MediaMedia





WebClientWebClient



SocketsSockets

CacheCache






PolicyPolicy





SynthesisSynthesis


Presentation



AnimationAnimation

ControlsControls

ControlControl

DesignDesign

PanelPanel

ControlsControls

DialogsDialogs

SideBarSideBar



DocumentsDocuments


ShapesShapes

ShapeShape

InkInk



FormsForms

ControlControl


DesignDesign


PagePage

ControlControl




AdaptorsAdaptors

DesignDesign




SynthesisSynthesis

5

Assistance Escalation PathAssistance Escalation Path

Well-Well-designed designed

app UIapp UI

Your Your product product support support centercenter

User User communitcommunit

yy

Help Pane Help Pane and and Help Help

CenterCenter

Assistance Assistance directly in directly in

app UIapp UI

6

“Longhorn” Assistance Model “Longhorn” Assistance Model

No context: “Safety net”

Directly in application

UX

In application context

7


8


9


10

Windows “Longhorn” Help Experience

Shane McRobertsGroup Program ManagerMicrosoft Help

11

New: Active ContentNew: Active Content

Focus on user tasks rather than documenting featuresTasks can launch UI (via ShellExecute)Content adapts to user/machine state

User is on a domainUser is an administratorA printer is connected

Focus on user tasks rather than documenting featuresTasks can launch UI (via ShellExecute)Content adapts to user/machine state

User is on a domainUser is an administratorA printer is connected

12

XP: User Must DecideXP: User Must Decide

13

“Longhorn” Help Knows State“Longhorn” Help Knows State

14

Assistance in ApplicationsAssistance in Applications

Identify user goals and tasksConsider adding assistance to UIDocument/implement tasksUse System.Help.Pane API to invoke tasksSurface search in your user interfaceDistribute Help with your application

Identify user goals and tasksConsider adding assistance to UIDocument/implement tasksUse System.Help.Pane API to invoke tasksSurface search in your user interfaceDistribute Help with your application

15

Programming The Help PaneProgramming The Help Pane

Instantiate System.Help.PaneInitialize session with session file

Content collection scopingBranding information (icon, title, etc.)

Display Navigate to topicShow TOCNavigate to taskEtc.

Instantiate System.Help.PaneInitialize session with session file

Content collection scopingBranding information (icon, title, etc.)

Display Navigate to topicShow TOCNavigate to taskEtc.

16

Pane, Canvas, TilePane, Canvas, Tile

Help PaneTitle/control bar

Header tile area Help Canvas area

Body tile area

Footer tile area

17

Help Pane ProxiesHelp Pane Proxies

Proxy

Proxy

SessionSession

18

Programming The Help Pane


19

Programming The Help PaneProgramming The Help Pane// Create a Help Pane Proxy Object // (session filename is currently ignored)System.Help.Pane pane = new

System.Help.Pane(“session”); …// Display a Help topicpane.DisplayTopicFromUri(myTopicUri); …// Display the table of contents for this collection pane.DisplayContents(); …// Display search results for a query pane.DisplaySearchResults(“install printer”);

// Create a Help Pane Proxy Object // (session filename is currently ignored)System.Help.Pane pane = new

System.Help.Pane(“session”); …// Display a Help topicpane.DisplayTopicFromUri(myTopicUri); …// Display the table of contents for this collection pane.DisplayContents(); …// Display search results for a query pane.DisplaySearchResults(“install printer”);

20

Help Authoring TodayHelp Authoring Today

Authors define content and presentationPresentation biased to particular viewerInteractivity biased to particular viewerSecurity, accessibility, extensibility require custom work for each viewerPresentation decided at/before build timeHard to take advantage of new capabilities

Authors define content and presentationPresentation biased to particular viewerInteractivity biased to particular viewerSecurity, accessibility, extensibility require custom work for each viewerPresentation decided at/before build timeHard to take advantage of new capabilities

21

Focus On SemanticsFocus On Semantics

Authors focus on solving user problemsAuthors define content and its attributesContent is presentation-independentContent is transformed before viewing

Presentation decided at transform timeInteractivity based on viewer capabilitiesSecurity, accessibility, extensibility improved

Easier to leverage new capabilities

Authors focus on solving user problemsAuthors define content and its attributesContent is presentation-independentContent is transformed before viewing

Presentation decided at transform timeInteractivity based on viewer capabilitiesSecurity, accessibility, extensibility improved

Easier to leverage new capabilities

22

Structured AuthoringStructured Authoring

XML schema for assistance: MAMLMicrosoft Assistance Markup LanguageExample: No <b> elementExample: No <popup> element

Some common transformationsMAML -> HTML is “lossy”HTML -> MAML is difficultXML -> MAML is relatively easy

New tools planned by Help Authoring Tool vendors

XML schema for assistance: MAMLMicrosoft Assistance Markup LanguageExample: No <b> elementExample: No <popup> element

Some common transformationsMAML -> HTML is “lossy”HTML -> MAML is difficultXML -> MAML is relatively easy

New tools planned by Help Authoring Tool vendors

23

Topics And Tasks Topics And Tasks

PDCTopics are Help content files (MAML files)Task definitions declare tasksTask implementations associate tasks/topics

Later versionsSimplified task modelTasks are Help content files (MAML files)Taskdata file declares task metadata and associates task MAML files

PDCTopics are Help content files (MAML files)Task definitions declare tasksTask implementations associate tasks/topics

Later versionsSimplified task modelTasks are Help content files (MAML files)Taskdata file declares task metadata and associates task MAML files

24

Help Source Files – PDCHelp Source Files – PDC

Packing list: .PackingList fileList of topics (.xml), taskdata, and resources

Help file, topic metadata: HelpMD fileDefines product, bundleSpecifies topic titles

Task/topic-specific metadata: TaskDef fileTask ID, title, index keywords

Task/topic implementation: TaskImp fileMaps Task ID to Topic URL

Topics: .xml file (in MAML format)


Help file, topic metadata: HelpMD fileDefines product, bundleSpecifies topic titles

Task/topic-specific metadata: TaskDef fileTask ID, title, index keywords

Task/topic implementation: TaskImp fileMaps Task ID to Topic URL

Topics: .xml file (in MAML format)

25

Help Source Files – LaterHelp Source Files – Later


Task metadata - .taskdata fileList of tasks, with titles and collection infoTask attributes such as keywordsTask categories (TOC data)ContentSet (collection) data

Topic/task implementation: .xml fileIn MAML format


Task metadata - .taskdata fileList of tasks, with titles and collection infoTask attributes such as keywordsTask categories (TOC data)ContentSet (collection) data

Topic/task implementation: .xml fileIn MAML format

26

Building A Help File


27

Kicking The TiresKicking The Tires

See documentation in “Longhorn” SDK

From Welcome page, click “’Longhorn’ Help System’” (under Technology Roadmap)

http://msdn.microsoft.com/longhornhttp://go.microsoft.com/fwlink/?LinkId=20559

See documentation in “Longhorn” SDK

From Welcome page, click “’Longhorn’ Help System’” (under Technology Roadmap)

http://msdn.microsoft.com/longhornhttp://go.microsoft.com/fwlink/?LinkId=20559

28

Continuous PublishingContinuous Publishing

Authoring follows newsroom modelAuthoring is driven by user dataUpdates are easy to distributeSize of update is proportional to changePublishing to Web is simplifiedWeb/client integration is enabled

Authoring follows newsroom modelAuthoring is driven by user dataUpdates are easy to distributeSize of update is proportional to changePublishing to Web is simplifiedWeb/client integration is enabled

29

Vendor SupportVendor SupportAnnouncing support today from...Announcing support today from...

30

SummarySummary

Assistance is integrated into “Longhorn” and “Longhorn” applicationsIt’s easy to add Help to “Longhorn” smart connected applicationsIncreased supportabilityreduced costs“Longhorn” Help is designed for all appsSystem.Help.Pane is the current API

Assistance is integrated into “Longhorn” and “Longhorn” applicationsIt’s easy to add Help to “Longhorn” smart connected applicationsIncreased supportabilityreduced costs“Longhorn” Help is designed for all appsSystem.Help.Pane is the current API

31

Community ResourcesGet your questions answered!Community ResourcesGet your questions answered!

Newsgroupmicrosoft.public.windows.developer.winfx.general

Longhorn DevCenter:http://msdn.microsoft.com/longhorn

Client Lounge: middle of the Exhibit Hallconnect with Microsoft client product teams, and PDC 2003 Speakers (including me)

Ask The ExpertsTuesday 7 pm – 9 pm in Hall G,H

Ask the Help [email protected]

Newsgroupmicrosoft.public.windows.developer.winfx.general

Longhorn DevCenter:http://msdn.microsoft.com/longhorn

Client Lounge: middle of the Exhibit Hallconnect with Microsoft client product teams, and PDC 2003 Speakers (including me)

Ask The ExpertsTuesday 7 pm – 9 pm in Hall G,H

Ask the Help [email protected]