Microsoft Help Viewer SDK

Articolo
10/10/2023

Questo articolo contiene le attività seguenti per gli integratori di Help Viewer di Visual Studio:

Creazione di un argomento (supporto F1)
Creazione di un pacchetto di personalizzazione del contenuto di Help Viewer
Distribuzione di un set di articoli
Aggiunta della Guida alla shell di Visual Studio (integrata o isolata)
Risorse aggiuntive

Creare un argomento (supporto F1)

Questa sezione offre una panoramica dei componenti di un argomento presentato, i requisiti dell'argomento, una breve descrizione per la creazione di un argomento (inclusi i requisiti di supporto F1) e infine un argomento di esempio con il relativo risultato sottoposto a rendering.

Panoramica dell'argomento help viewer

Quando viene chiamato un argomento per il rendering, help viewer ottiene gli elementi del pacchetto di personalizzazione associati all'argomento al momento dell'installazione o dell'ultimo aggiornamento, insieme all'argomento XHTML e combina i due per ottenere la visualizzazione contenuto presentata (dati di personalizzazione e dati dell'argomento). Il pacchetto di personalizzazione contiene logo, supporto per comportamenti del contenuto e testo di personalizzazione (copyright e così via). Per altre informazioni sugli elementi del pacchetto di personalizzazione, vedere "Creating Branding Package" di seguito. Nel caso in cui all'argomento non sia associato alcun pacchetto di personalizzazione, help viewer userà il pacchetto di personalizzazione di fallback disponibile nella radice dell'applicazione help viewer (Branding_en-US.mshc).

Requisiti dell'argomento help viewer

Per il rendering corretto all'interno del Visualizzatore della Guida, il contenuto dell'argomento non elaborato deve essere W3C Basic 1.1 XHTML.

Un argomento contiene in genere due sezioni:

Metadati (vedere Riferimento ai metadati del contenuto): dati relativi all'argomento, ad esempio ID univoco dell'argomento, valore di parola chiave, ID sommario, ID nodo padre e così via.
Contenuto del corpo: conforme a W3C Basic 1.1 XHTML, che include comportamenti di contenuto supportati (area comprimibile, frammento di codice e così via. Di seguito è riportato un elenco completo.

Controlli supportati dal pacchetto di personalizzazione di Visual Studio:

Collegamenti
CodeSnippet
CollapsibleArea
Membro ereditato
LanguageSpecificText

Stringhe di lingua supportate (senza distinzione tra maiuscole e minuscole):

JavaScript
csharp o c#
cplusplus o visualc++ o c++
jscript
visualbasic o vb
f# o fsharp o fs
other : stringa che rappresenta un nome di lingua

Creazione di un argomento help viewer

Creare un nuovo documento XHTML denominato ContosoTopic4.htm e includere il tag title (di seguito).

<html>
<head>
<title>Contoso Topic 4</title>
</head>

<body>

</body>
</html>

Successivamente, aggiungere dati per definire la modalità di presentazione dell'argomento (auto-marcata o meno), come fare riferimento a questo argomento per F1, dove questo argomento esiste all'interno del SOMMARIO, il relativo ID (per riferimento ai collegamenti da altri argomenti) e così via. Per un elenco completo dei metadati supportati, vedere la tabella "Metadati del contenuto" di seguito.

In questo caso, useremo il nostro pacchetto di personalizzazione, una variante del pacchetto di personalizzazione di Visual Studio Help Viewer.
Aggiungere il nome meta F1 e il valore ("Microsoft.Help.F1" content=" ContosoTopic4") che corrisponderà al valore F1 fornito nel contenitore delle proprietà dell'IDE. Per altre informazioni, vedere la sezione Supporto F1. Si tratta del valore corrispondente alla chiamata F1 dall'interno dell'IDE per visualizzare questo argomento quando si seleziona F1 nell'IDE.
Aggiungere l'ID argomento. Stringa utilizzata da altri argomenti per collegarsi a questo argomento. È l'ID visualizzatore della Guida per questo argomento.
Per il sommario, aggiungere il nodo padre di questo argomento per definire dove verrà visualizzato questo argomento.
Per il sommario, aggiungere l'ordine dei nodi di questo argomento. Quando il nodo padre ha n il numero di nodi figlio, definire nell'ordine dei nodi figlio la posizione di questo argomento. Ad esempio, questo argomento è il numero 4 di 4 argomenti figlio.

Sezione dei metadati di esempio:

<html>
<head>
<title>Contoso Topic 4</title>

<meta name="SelfBranded" content="false" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />

</head>

<body>

</body>
</html>

Corpo dell'argomento

Il corpo (non incluso l'intestazione e il piè di pagina) dell'argomento conterrà collegamenti di pagina, una sezione nota, un'area collapsibile, un frammento di codice e una sezione di testo specifico della lingua. Vedere la sezione personalizzazione per informazioni su tali aree dell'argomento presentato.

Aggiungere un tag del titolo dell'argomento: <div class="title">Contoso Topic 4</div>
Aggiungere una sezione note: <div class="alert"> add your table tag and text </div>
Aggiungere un'area collapsible: <CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading"> add text </CollapsibleArea>
Aggiungere un frammento di codice: <CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" > a block of code </CodeSnippet>
Aggiungere testo specifico della lingua del codice: <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" /> si noti che devLangnu= consente di immettere altre lingue. Ad esempio, devLangnu="Fortran" visualizza Fortran quando il frammento di codice DisplayLanguage = Fortran
Aggiungere collegamenti di pagina: <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>

Nota

Nota: per la colorazione del codice "Display Language" (ad esempio, F#, Cobol, Fortran) nel frammento di codice sarà monocromatico.

Esempio di argomento help viewer Il codice illustra come definire metadati, un frammento di codice, un'area comprimibile e un testo specifico della lingua.

<?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<title>Contoso Topic 4</title>

    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta name="Microsoft.Help.Id" content="ContosoTopic4" />
<meta name="Microsoft.Help.F1" content=" ContosoTopic4" />
    <meta name="Language" content="en-us" />
<meta name="Microsoft.Help.TocParent" content="ContosoTopic0" />
<meta name="Microsoft.Help.TocOrder" content="4" />
<meta name="SelfBranded" content="false" />
</head>

<body>
<div class="title">Contoso Topic 4</div>

  <div id="header">
<table id="bottomTable" cellpadding="0" cellspacing="0"  width="100%">
        <tr id="headerTableRow2"><td align="left">
            <span id="nsrTitle">Contoso Topic 1</span>
          </td>
<td align="right">
</td></tr>
<tr id="headerTableRow1"><td align="left">
            <span id="runningHeaderText">Contoso Widgets & Sprockets</span>
          </td></tr>
      </table>
</div>

<h2>Table of Contents</h2>

<ul class="toc">
<li class="tocline1"><a href="#introduction" target="_self">1.0 Introduction</a></li>
<li class="tocline1"><a href="#related-content" target="_self">Related content</a></li>
</ul>

<div class="topic">

<div id="mainSection">
<div id="mainBody">

<a name="introduction"></a>
<h2>1.0 Introduction</h2>
<p>[This documentation is for sample purposes only.]</p>

<p>Contoso Topic 1 contains examples of:
<ul>
<li>Collapsible Area</li>
<li>Bookmark ("Related content")</li>
<li>Code Snippets from Branding Package</li>
</ul>
 </p>
<div class="alert"><table><tr><th>
<strong>Note </strong></th></tr>
<tr><td>
<p>This is an example of a <span class="label">Note </span>section.
Call out important items for your reader in this <span class="label">Note </span>box.
</p></td></tr>
</table>
</div>
</div>

<CollapsibleArea Expanded="1" Title="Collapsible Area Test Heading">

            <a id="sectionToggle0"><!----></a>

<div>
Example of Collapsible Area
<br/>
Lorem ipsum dolor sit amet...
</div>
</CollapsibleArea>

<div id="snippetGroup" >
<CodeSnippet EnableCopyCode="true" Language="VisualBasic" ContainsMarkup="false" DisplayLanguage="Visual Basic" >
Private Sub ToolStripRenderer1_RenderGrip(sender as Object, e as ToolStripGripRenderEventArgs) _ Handles ToolStripRenderer1.RenderGrip
Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds)
    messageBoxVB.AppendLine()
 ...
    MessageBox.Show(messageBoxVB.ToString(),"RenderGrip Event")
End Sub
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="CSharp" ContainsMarkup="false" DisplayLanguage="C#" >
private void ToolStripRenderer1_RenderGrip(Object sender, ToolStripGripRenderEventArgs e)
{
System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "GripBounds", e.GripBounds );
messageBoxCS.AppendLine();
...
MessageBox.Show(messageBoxCS.ToString(), "RenderGrip Event" );
}
</CodeSnippet>

<CodeSnippet EnableCopyCode="true" Language="fsharp" ContainsMarkup="false" DisplayLanguage="F#" >
some F# code
</CodeSnippet>
</div>

<h4 class="subHeading">Example of code specific text</h4>Language = <LanguageSpecificText devLangcs="CS" devLangvb="VB" devLangcpp="C++" devLangnu="F#" />

<a name="related-content"></a>
<h1 class="heading">Related content</h1>

    <div id="relatedcontentSection" class="section">
    <div class="relatedcontentStyle">
        <a href="ms-xhelp:///?Id=ContosoTopic1">Main Topic</a>
    </div>
 </div>
</div>
</div>
</body>
</html>

Supporto F1

In Visual Studio, selezionando F1 vengono generati i valori forniti dal posizionamento del cursore all'interno dell'IDE e viene popolato un "contenitore delle proprietà" con i valori forniti (in base alla posizione del cursore. Quando il cursore è posizionato sulla funzionalità x, la funzionalità x è attiva/attiva/attiva e popola il contenitore delle proprietà con valori. Quando si seleziona F1, il contenitore delle proprietà viene popolato e il codice F1 di Visual Studio cerca di verificare se l'origine della Guida predefinita dei clienti è locale o online (online è l'impostazione predefinita), crea la stringa appropriata in base all'impostazione degli utenti (online è l'impostazione predefinita) - Esecuzione della shell (vedere la Guida Amministrazione istrator guida per i parametri di avvio exe) con parametri per il visualizzatore della Guida locale e le parole chiave dal contenitore delle proprietà se la Guida locale è l'impostazione predefinita, o l'URL MSDN con la parola chiave nell'elenco dei parametri.

Se per F1 vengono restituite tre stringhe, denominate stringa multivalore, prendere il primo termine, cercare un riscontro e, se trovato, è stato fatto; in caso contrario, passare alla stringa successiva. L'ordine è importante. La presentazione delle parole chiave multivalore deve essere una stringa più lunga fino alla stringa più breve. Per verificarlo nel caso di parole chiave multivalore, esaminare la stringa URL F1 online, che includerà la parola chiave scelta.

In Visual Studio 2012 è stata intenzionalmente fatta una divisione più forte tra online e offline, in modo che, se l'impostazione dell'utente fosse per Online, è stata semplicemente passata la richiesta F1 direttamente al servizio di query online su MSDN anziché il routing tramite l'agente della libreria della Guida disponibile in Visual Studio 2010. Ci si basa quindi su uno stato di "contenuto fornitore installato = true" per determinare se eseguire un'operazione diversa in tale contesto. Se true, questa logica di analisi e routing viene eseguita a seconda di ciò che si vuole supportare per i clienti. Se false, si passa a MSDN. Se l'impostazione dell'utente è locale, tutte le chiamate passano al motore della Guida locale.

Diagramma di flusso F1:

Flusso F1

Quando l'origine del contenuto della Guida predefinita di Help Viewer è impostata su online (Avvio nel browser):

Le funzionalità di Visual Studio Partner (VSP) generano un valore per il contenitore delle proprietà F1 (property bag prefix.keyword e URL online per il prefisso trovato nel Registro di sistema): F1 invia un URL VSP+ parametri al browser.
Funzionalità di Visual Studio (editor di linguaggio, voci di menu specifiche di Visual Studio e così via): F1 invia un URL di Visual Studio al browser.

Quando l'origine del contenuto della Guida predefinita di Help Viewer è impostata su Guida locale (Avvio in Help Viewer):

Funzionalità del provider di servizi virtuali in cui la corrispondenza della parola chiave tra il contenitore delle proprietà F1 e l'indice dell'archivio locale( ovvero il prefisso del contenitore delle proprietà = il valore trovato nell'indice dell'archivio locale): F1 esegue il rendering dell'argomento nel Visualizzatore della Guida.
Funzionalità di Visual Studio (nessuna opzione per il provider di servizi virtuali per eseguire l'override del contenitore delle proprietà generato dalle funzionalità di Visual Studio): F1 esegue il rendering di un argomento di Visual Studio nel Visualizzatore della Guida.

Impostare i valori del Registro di sistema seguenti per abilitare il fallback F1 per il contenuto della Guida del fornitore. F1 Fallback indica che Help Viewer è impostato per cercare il contenuto della Guida F1 online e il contenuto del fornitore viene installato localmente sul disco rigido degli utenti. Help Viewer dovrebbe esaminare la Guida locale per il contenuto anche se l'impostazione predefinita è per la Guida online.

Impostare il valore VendorContent nella chiave del Registro di sistema della Guida 2.3:
- Per i sistemi operativi a 32 bit:
  
  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Catalogs\VisualStudio15
  
  "VendorContent"=dword:00000001
- Per i sistemi operativi a 64 bit:
  
  HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15
  
  "VendorContent"=dword:00000001
Registrare lo spazio dei nomi partner nella chiave del Registro di sistema della Guida 2.3:
- Per i sistemi operativi a 32 bit:
  
  HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\v2.3\Partner\<namespace>
  
  "location"="offline"
- Per i sistemi operativi a 64 bit:
  
  HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Partner\<namespace>
  
  "location"="offline"

Analisi dello spazio dei nomi nativo di base

Per attivare l'analisi dello spazio dei nomi nativo di base, nel Registro di sistema aggiungere un nuovo DWORD in base al nome: BaseNativeNamespaces e impostarne il valore su 1 (sotto la chiave del catalogo che desidera supportare). Ad esempio, se si vuole usare il catalogo di Visual Studio, è possibile aggiungere la chiave al percorso:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

Quando viene rilevata una parola chiave F1 nel formato HEADER/METHOD, il carattere '/' verrà analizzato, generando il costrutto seguente:

INTESTAZIONE: sarà lo spazio dei nomi che può essere usato per la registrazione nel Registro di sistema
METODO: diventerà la parola chiave che viene passata.

Ad esempio, data una libreria personalizzata denominata CustomLibrary e un metodo denominato MyTestMethod, quando viene inserita una richiesta F1 verrà formattata come CustomLibrary/MyTestMethod.

Un utente può quindi registrare CustomLibrary come spazio dei nomi nell'hive Partner e specificare la chiave di posizione desiderata e la parola chiave passata alla query sarà MyTestMethod.

Abilitare lo strumento di debug della Guida nell'IDE

Aggiungere la chiave e il valore del Registro di sistema seguenti:

HKEY_CURRENT_U edizione Standard R\Software\Microsoft\VisualStudio\16.0\Guida dinamica

Valore: visualizzare l'output di debug nei dati delle vendite al dettaglio: SÌ

Nell'IDE, sotto la voce di menu ? selezionare Contesto della Guida di debug.

Metadati del contenuto

Nella tabella seguente, qualsiasi stringa visualizzata tra parentesi quadre è un segnaposto che deve essere sostituito da un valore riconosciuto. Ad esempio, in <meta name="Microsoft.Help.Locale" content="[language code]" />, "[language code]" deve essere sostituito da un valore come "en-us".

Proprietà (rappresentazione HTML)	Descrizione
< meta name="Microsoft.Help.Locale" content="[language-code]" />	Imposta le impostazioni locali per questo argomento. Se questo tag viene usato in un argomento, deve essere usato una sola volta e deve essere inserito sopra qualsiasi altro tag della Guida Microsoft. Se questo tag non viene utilizzato, il testo del corpo dell'argomento viene indicizzato utilizzando word breaker associato alle impostazioni locali del prodotto, se specificato; in caso contrario, viene usato il word breaker en-us. Questo tag è conforme a ISOC RFC 4646. Per garantire il corretto funzionamento della Guida di Microsoft, utilizzare questa proprietà anziché l'attributo Language generale.
< meta name="Microsoft.Help.TopicLocale" content="[language-code]" />	Imposta le impostazioni locali per questo argomento quando vengono usate anche altre impostazioni locali. Se questo tag viene usato in un argomento, deve essere usato una sola volta. Usare questo tag quando il catalogo contiene contenuto in più lingue. Più argomenti in un catalogo possono avere lo stesso ID, ma ognuno deve specificare un ArgomentoLocale univoco. L'argomento che specifica topicLocale che corrisponde alle impostazioni locali del catalogo è l'argomento visualizzato nel sommario. Tuttavia, tutte le versioni linguistiche dell'argomento vengono visualizzate nei risultati della ricerca.
< title>[Title]</title>	Specifica il titolo di questo argomento. Questo tag è obbligatorio e deve essere usato una sola volta in un argomento. Se il corpo dell'argomento non contiene una sezione div> del titolo<, questo titolo viene visualizzato nell'argomento e nel sommario.
< meta name=" Microsoft.Help.Keywords" content="[aKeywordPhrase]"/>	Specifica il testo di un collegamento visualizzato nel riquadro dell'indice del Visualizzatore della Guida. Quando si fa clic sul collegamento, viene visualizzato l'argomento. È possibile specificare più parole chiave di indice per un argomento oppure omettere questo tag se non si desidera che i collegamenti a questo argomento vengano visualizzati nell'indice. Le parole chiave "K" delle versioni precedenti della Guida possono essere convertite in questa proprietà.
< meta name="Microsoft.Help.Id" content="[TopicID]"/>	Imposta l'identificatore per questo argomento. Questo tag è obbligatorio e deve essere usato una sola volta in un argomento. L'ID deve essere univoco tra gli argomenti del catalogo con la stessa impostazione delle impostazioni locali. In un altro argomento è possibile creare un collegamento a questo argomento usando questo ID.
< meta name="Microsoft.Help.F1" content="[System.Windows.Controls.Primitives.IReitemContainerGenerator]"/>	Specifica la parola chiave F1 per questo argomento. È possibile specificare più parole chiave F1 per un argomento oppure omettere questo tag se non si desidera che questo argomento venga visualizzato quando un utente dell'applicazione preme F1. In genere, per un argomento viene specificata una sola parola chiave F1. Le parole chiave "F" delle versioni precedenti della Guida possono essere convertite in questa proprietà.
< meta name="Description" content="[topic description]" />	Fornisce un breve riepilogo del contenuto in questo argomento. Se questo tag viene usato in un argomento, deve essere usato una sola volta. Questa proprietà è accessibile direttamente dalla libreria di query; non viene archiviato nel file di indice.
meta name="Microsoft.Help.TocParent" content="[parent_Id]"/>	Specifica l'argomento padre di questo argomento nel sommario. Questo tag è obbligatorio e deve essere usato una sola volta in un argomento. Il valore è il Microsoft.Help.Id dell'elemento padre. Un argomento può avere una sola posizione nel sommario. "-1" viene considerato l'ID argomento per la radice toc. In Visual Studio 2013 questa pagina è la home page di Help Viewer. Questo è lo stesso motivo per cui aggiungiamo in modo specifico TocParent=-1 ad alcuni argomenti per assicurarsi che vengano visualizzati al livello superiore. La home page del Visualizzatore della Guida è una pagina di sistema e quindi non sostituibile. Se un provider di servizi virtuali tenta di aggiungere una pagina con ID -1, potrebbe essere aggiunto al set di contenuto, ma Help Viewer userà sempre la pagina di sistema - Help Viewer Home
< meta name="Microsoft.Help.TocOrder" content="[positive integer]"/>	Specifica dove nel sommario questo argomento viene visualizzato in relazione ai relativi argomenti peer. Questo tag è obbligatorio e deve essere usato una sola volta in un argomento. Il valore è un numero intero. Un argomento che specifica un intero con valore inferiore viene visualizzato sopra un argomento che specifica un intero con valori più elevati.
< meta name="Microsoft.Help.Product" content="[product code]"/>	Specifica il prodotto descritto in questo argomento. Se questo tag viene usato in un argomento, deve essere usato una sola volta. Queste informazioni possono essere fornite anche come parametro passato all'indicizzatore della Guida.
< meta name="Microsoft.Help.ProductVersion" content="[numero di versione]"/>	Specifica la versione del prodotto descritta in questo argomento. Se questo tag viene usato in un argomento, deve essere usato una sola volta. Queste informazioni possono essere fornite anche come parametro passato all'indicizzatore della Guida.
< meta name="Microsoft.Help.Category" content="[string]"/>	Usato dai prodotti per identificare le sottosezioni del contenuto. È possibile identificare più sottosezioni per un argomento oppure omettere questo tag se non si desidera che i collegamenti identifichino eventuali sottosezioni. Questo tag viene usato per archiviare gli attributi per TargetOS e TargetFrameworkMoniker quando un argomento viene convertito da una versione precedente della Guida. Il formato del contenuto è AttributeName:AttributeValue.
< meta name="Microsoft.Help.TopicVersion content="[numero di versione dell'argomento]"/>	Specifica questa versione dell'argomento quando sono presenti più versioni in un catalogo. Poiché Microsoft.Help.Id non è garantito che sia univoco, questo tag è obbligatorio quando esistono più versioni di un argomento in un catalogo, ad esempio quando un catalogo contiene un argomento per .NET Framework 3.5 e un argomento per .NET Framework 4 e entrambi hanno lo stesso Microsoft.Help.Id.
<meta name="SelfBranded" content="[TRUE o FAL edizione Standard]"/>	Specifica se in questo argomento viene utilizzato il pacchetto di personalizzazione di Help Library Manager o un pacchetto di personalizzazione specifico dell'argomento. Questo tag deve essere TRUE o FAL edizione Standard. Se è TRUE, il pacchetto di personalizzazione per l'argomento associato esegue l'override del pacchetto di personalizzazione impostato all'avvio di Gestione librerie della Guida in modo che venga eseguito il rendering dell'argomento come previsto anche se differisce dal rendering di altri contenuti. Se si tratta di FAL edizione Standard, il rendering dell'argomento corrente viene eseguito in base al pacchetto di personalizzazione impostato all'avvio di Help Library Manager. Per impostazione predefinita, Help Library Manager presuppone che la personalizzazione sia false a meno che la variabile SelfBranded non sia dichiarata come TRUE; pertanto, non è necessario dichiarare <meta name="SelfBranded" content="FAL edizione Standard"/>.

Creare un pacchetto di personalizzazione

La versione di Visual Studio include diversi prodotti di Visual Studio, tra cui le shell isolate e integrate per i partner di Visual Studio. Ognuno di questi prodotti richiede un certo livello di supporto per la personalizzazione dei contenuti della Guida basata su argomenti, univoco per il prodotto. Ad esempio, gli argomenti di Visual Studio devono avere una presentazione coerente del marchio, mentre SQL Studio, che esegue il wrapping di ISO Shell, richiede una personalizzazione univoca del contenuto della Guida per ogni argomento. Un partner shell integrato potrebbe volere che gli argomenti della Guida siano inclusi nel contenuto della Guida del prodotto Visual Studio padre mantenendo al tempo stesso la propria personalizzazione degli argomenti.

I pacchetti di personalizzazione vengono installati dal prodotto contenente help viewer. Per i prodotti Visual Studio:

Un pacchetto di personalizzazione di fallback (Branding_<locale.mshc>) viene installato nella radice dell'app Help Viewer 2.3 (ad esempio: C:\Programmi (x86)\Microsoft Help Viewer\v2.3) dal Language Pack help viewer. Questo viene usato per i casi in cui il pacchetto di personalizzazione del prodotto non è installato (nessun contenuto è stato installato) o in cui il pacchetto di personalizzazione installato è danneggiato. Gli elementi di Visual Studio (logo e Feedback) vengono ignorati quando viene usato il pacchetto di personalizzazione del fallback radice dell'app.
Quando il contenuto di Visual Studio viene installato dal servizio pacchetto di contenuto, viene installato anche un pacchetto di personalizzazione (per la prima volta lo scenario di installazione del contenuto). Se è presente un aggiornamento del pacchetto di personalizzazione, l'aggiornamento viene installato quando si verifica l'aggiornamento del contenuto successivo o l'azione di installazione aggiuntiva del pacchetto.

Microsoft Help Viewer supporta la personalizzazione degli argomenti in base ai metadati degli argomenti.

Dove i metadati dell'argomento definiscono automaticamente il marchio = true, eseguire il rendering dell'argomento così com'è, non eseguire alcuna operazione (per quanto riguarda la personalizzazione).
Dove i metadati dell'argomento definiscono self-branded = false, usare il pacchetto di personalizzazione associato al valore dei metadati TopicVendor.
Dove i metadati dell'argomento definiscono name="Microsoft.Help.TopicVendor" content=< branding package name in vendor MSHA>, usare il pacchetto di personalizzazione definito nel valore del contenuto.
All'interno del catalogo di Visual Studio è disponibile un'applicazione prioritaria dei pacchetti di personalizzazione. Prima viene applicata la personalizzazione predefinita di Visual Studio e quindi, se definita nei metadati dell'argomento e supportata con il pacchetto di personalizzazione associato (come definito nell'installazione msha), il fornitore definito personalizzazione viene applicato come override.

Gli elementi di personalizzazione in genere rientrano in tre categorie principali:

Elementi di intestazione (esempi includono il collegamento ai commenti e suggerimenti, il testo della dichiarazione di non responsabilità condizionale, il logo)
Comportamenti del contenuto (esempi includono elementi di testo di controllo expand/collapse e elementi del frammento di codice)
Elementi piè di pagina (esempio Copyright)

Gli elementi considerati come elementi branded includono (in dettaglio in questa specifica):

Logo catalogo/prodotto (ad esempio, Visual Studio)
Collegamento ai commenti e suggerimenti e elementi di posta elettronica
Testo della clausola di responsabilità
Testo copyright

I file di supporto nel pacchetto di personalizzazione di Help Viewer di Visual Studio includono:

Grafica (logo, icone e così via)
Branding.js - File di script che supportano i comportamenti del contenuto
Branding.xml: stringhe usate in modo coerente nel contenuto del catalogo. Nota: per gli elementi di testo di localizzazione di Visual Studio nella branding.xml, includere _locID="<valore univoco>"
Branding.css - Definizioni di stile per la coerenza della presentazione
Printing.css - Definizioni di stile per una presentazione stampata coerente

Come indicato in precedenza, i pacchetti di personalizzazione sono associati all'argomento:

Quando SelfBranded = false è definito nei metadati, l'argomento eredita il pacchetto di personalizzazione del catalogo
Oppure quando SelfBranded = false e esiste un pacchetto di personalizzazione univoco definito in MSHA e disponibile quando il contenuto è installato

Per i VSP che implementano pacchetti di personalizzazione (contenuto VSP, SelfBranded=True), un modo per procedere consiste nell'iniziare con il pacchetto di personalizzazione del fallback (installato con help viewer) e modificare il nome del file in base alle esigenze. Il file Branding_<locale.mshc è un file ZIP con l'estensione di file modificato in .mshc, quindi è sufficiente modificare l'estensione> da .mshc a .zip ed estrarre il contenuto. Vedere di seguito per informazioni sugli elementi del pacchetto di personalizzazione e modificare in base alle esigenze (ad esempio, modificare il logo con il logo VSP e il riferimento al logo nel file Branding.xml, aggiornare Branding.xml per specifiche di VSP e così via).

Al termine di tutte le modifiche, creare un file ZIP contenente gli elementi di personalizzazione desiderati e modificare l'estensione in mshc.

Per associare il pacchetto di personalizzazione, creare l'MSHA, che contiene il riferimento al file mshc di personalizzazione insieme al contenuto mshc (contenente gli argomenti). Vedere di seguito "MSHA" per informazioni su come creare un MSHA di base.

Il file Branding.xml contiene un elenco di elementi utilizzati per il rendering coerente di elementi specifici in un argomento quando l'argomento contiene <meta name="Microsoft.Help.SelfBranded" content="false"/>. Di seguito è riportato l'elenco di elementi di Visual Studio nel file Branding.xml. Questo elenco è destinato a essere usato come modello per gli adopter ISO Shell, in cui modificano questi elementi (ad esempio logo, feedback e copyright) per soddisfare le proprie esigenze di personalizzazione del prodotto.

Nota: le variabili annotate da "{n}" hanno dipendenze del codice. La rimozione o la modifica di questi valori causerà errori ed eventualmente arresto anomalo dell'applicazione. Gli identificatori di localizzazione (ad esempio _locID="codesnippet.n") sono inclusi nel pacchetto di personalizzazione di Visual Studio.

Branding.xml

Elemento	Descrizione
Funzionalità:	CollapsibleArea
Usa:	Espandi comprime il testo del controllo contenuto
elemento	valore
ExpandText	Espandi
CollapseText	Comprimi
Funzionalità:	CodeSnippet
Usa:	Testo del controllo del frammento di codice. Nota: il contenuto del frammento di codice con spazio "Non di rilievo" verrà modificato nello spazio.
elemento	valore
CopyToClipboard	Copia negli Appunti
ViewColorizedText	Visualizzazione colorata
CombinedVBTabDisplayLanguage	Visual Basic (esempio)
VBDeclaration	Dichiarazione
VBUsage	Utilizzo
Funzionalità:	Feedback, piè di pagina e logo
Usa:	Fornire un controllo Feedback per consentire al cliente di fornire commenti e suggerimenti sull'argomento corrente tramite posta elettronica. Testo del copyright per il contenuto. Definizione del logo.
elemento	Valore (queste stringhe possono essere modificate per soddisfare le esigenze dell'adozione del contenuto).
Copyright	© 2013 Microsoft Corporation. Tutti i diritti sono riservati.
SendFeedback	<a href="{0}" {1}>Invia commenti e< suggerimenti/a> su questo argomento a Microsoft.
FeedbackLink
LogoTitle	Visual Studio 2013
LogoFileName	vs_logo_bk.gif
LogoFileNameHC	vs_logo_wh.gif
Funzionalità:	Dichiarazione di non responsabilità
Usa:	Set di dichiarazioni di non responsabilità specifiche del caso per il contenuto convertito in computer.
elemento	valore
MT_Editable	Questo articolo è stato tradotto automaticamente. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
MT_NonEditable	Questo articolo è stato tradotto automaticamente. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
MT_QualityEditable	Questo articolo è stato tradotto manualmente. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
MT_QualityNonEditable	Questo articolo è stato tradotto manualmente. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
MT_BetaContents	Questo articolo è stato tradotto automaticamente per una versione preliminare. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
MT_BetaRecycledContents	Questo articolo è stato tradotto manualmente per una versione preliminare. Se si dispone di una connessione Internet, selezionare "Visualizza questo argomento online" per visualizzare questa pagina in modalità modificabile con il contenuto originale in inglese contemporaneamente.
Funzionalità:	LinkTable
Usa:	Supporto per i collegamenti agli argomenti online
elemento	valore
LinkTableTitle	Collega tabella
TopicEnuLinkText	Visualizzare la versione< inglese/a> di questo argomento disponibile nel computer.
TopicOnlineLinkText	Visualizzare questo argomento <a href="{0}" {1}>online</a>
OnlineText	Online
Funzionalità:	Controllo Audio video
Usa:	Visualizzare elementi e testo per il contenuto video
elemento	valore
MultiMediaNotSupported	Internet Explorer 9 o versione successiva deve essere installato per supportare il {0} contenuto.
Videotext	visualizzazione di video
AudioText	streaming audio
OnlineVideoLinkText	<p>Per visualizzare il video associato a questo argomento, fare clic su {0}<un href=""{1}>{2}here</a>.</P>
OnlineAudioLinkText	<p>Per ascoltare l'audio associato a questo argomento, fare clic su {0}<un href=""{1}>{2}here</a>.</P>
Funzionalità:	Controllo Contenuto non installato
Usa:	Elementi di testo (stringhe) utilizzati per il rendering di contentnotinstalled.htm
elemento	valore
ContentNotInstalledTitle	Nessun contenuto trovato nel computer.
ContentNotInstalledDownloadContentText	<p>Per scaricare il contenuto nel computer, <un href="{0}" {1}>fare clic sulla scheda< Gestisci/a>.</P>
ContentNotInstalledText	<p>Nessun contenuto installato nel computer. Vedere il Amministrazione istrator per l'installazione del contenuto della Guida locale.</P>
Funzionalità:	Controllo Argomento non trovato
Usa:	Elementi di testo (stringhe) usati per il rendering di topicnotfound.htm
elemento	valore
TopicNotFoundTitle	Impossibile trovare l'argomento richiesto nel computer.
TopicNotFoundViewOnlineText	<p>L'argomento richiesto non è stato trovato nel computer, ma è possibile <visualizzare{0}{1}> l'argomento online</a>.</P>
TopicNotFoundDownloadContentText	<p>Vedere il riquadro di spostamento per i collegamenti ad argomenti simili o <href="{0}" {1}>fare clic sulla scheda< Gestisci/a> per scaricare il contenuto nel computer.</P>
TopicNotFoundText	<p>L'argomento richiesto non è stato trovato nel computer.</P>
Funzionalità:	Controllo danneggiato dell'argomento
Usa:	Elementi di testo (stringhe) usati per il rendering di topiccorrupted.htm
elemento	valore
ArgomentoCorruptedTitle	Impossibile visualizzare l'argomento richiesto.
TopicCorruptedViewOnlineText	<p>Help Viewer non è in grado di visualizzare l'argomento richiesto. Potrebbe verificarsi un errore nel contenuto dell'argomento o in una dipendenza di sistema sottostante.</P>
Funzionalità:	Controllo Home Page
Usa:	Testo che supporta la visualizzazione del contenuto principale del nodo help viewer.
elemento	valore
HomePageTitle	Help Viewer Home
HomePageIntroduzione	<p>Benvenuto in Microsoft Help Viewer, una fonte essenziale di informazioni per tutti gli utenti che usano strumenti, prodotti, tecnologie e servizi Microsoft. Help Viewer consente di accedere alle procedure e alle informazioni di riferimento, al codice di esempio, agli articoli tecnici e altro ancora. Per trovare il contenuto necessario, esplorare il sommario, usare la ricerca full-text o esplorare il contenuto usando l'indice delle parole chiave.</P>
HomePageContentInstallText	<p><br />Use the <a href="{0}" {1}>Manage Content</a> tab to do the following:<ul><li>Add content to your computer.</li><li>Controllare la disponibilità di aggiornamenti al contenuto locale.</li><li>Rimuovere il contenuto dal computer.</li></ul></p>
HomePageInstalledBooks	Libri installati
HomePageNoBooksInstalled	Nessun contenuto trovato nel computer.
HomePageHelp Impostazioni	Contenuto della Guida Impostazioni
HomePageHelp Impostazioni Text	<p>L'impostazione corrente è la Guida locale. Help Viewer visualizza il contenuto installato nel computer.<br />Per modificare l'origine del contenuto della Guida, nella barra dei menu di Visual Studio scegliere <span style=""{0}Guida>, Imposta preferenza/intervallo<> della Guida.<br /></p>
MegaByte	MB

branding.js

Il file branding.js contiene JavaScript usato dagli elementi di personalizzazione di Visual Studio Help Viewer. Di seguito è riportato un elenco degli elementi di personalizzazione e della funzione JavaScript di supporto. Tutte le stringhe da localizzare per questo file sono definite nella sezione "Stringhe localizzabili" nella parte superiore di questo file. Il file ICL è stato creato per le stringhe loc all'interno del file branding.js.

Funzionalità di personalizzazione	Funzione JavaScript	Descrizione
Var...		Definire le variabili
Ottenere la lingua del codice utente	setUserPreferenceLang	esegue il mapping di un indice # al linguaggio di codice
Impostare e ottenere i valori dei cookie	getCookie, setCookie
Membro ereditato	changeMembersLabel	Espandere/comprimere un membro ereditato
Quando SelfBranded=False	Onload	Leggere la stringa di query per verificare se si tratta di una richiesta di stampa. Impostare tutti i codicinippets per concentrarsi sulla scheda preferita dall'utente. Se si tratta di una richiesta di stampa, impostare isPrinterFriendly su true. Verificare la modalità a contrasto elevato.
Frammento di codice	addSpecificTextLanguageTagSet
	getIndexFromDevLang
	ChangeTab
	setCodesnippetLang
	setCurrentLang
	CopyToClipboard
CollapsibleArea	addToCollapsibleControlSet	scrivere tutto l'oggetto controllo collapsible nell'elenco.
	CA_Click	in base allo stato dell'area collapsible, definisce l'immagine e il testo da presentare
Supporto del contrasto per logo	isBlackBackground()	Chiamato per determinare se lo sfondo è nero. Accurato solo quando è in modalità a contrasto elevato.
	isHighContrast()	usare un intervallo colorato per rilevare la modalità a contrasto elevato
	onHighContrast(black)	Chiamato quando viene rilevato un contrasto elevato
Funzionalità LST
	addToLanSpecTextIdSet(id)
	updateLST(currentLang)
	getDevLangFromCodeSnippet(lang)
Funzionalità multimedia	didascalia(begin, end, text, style)
	findAllMediaControls(normalizedId)
	getActivePlayer(normalizedId)
	didascalia sOnOff(id)
	toSeconds(t)
	getAllComments(node)
	styleRectify(styleName, styleValue)
	showCC(id)
	subtitle(id)

FILE HTM

Il pacchetto di personalizzazione contiene un set di file HTM che supportano scenari per la comunicazione delle informazioni chiave per gli utenti del contenuto della Guida, ad esempio una home page contenente una sezione che descrive quali set di contenuti sono installati e le pagine che informano l'utente quando gli argomenti non sono disponibili nel set locale di argomenti. Questi file HTM possono essere modificati per prodotto. I fornitori di ISO Shell possono prendere il pacchetto di personalizzazione predefinito e modificare il comportamento e il contenuto di queste pagine in base alle proprie esigenze. Questi file fanno riferimento al rispettivo pacchetto di personalizzazione affinché i tag di personalizzazione ottengano il contenuto corrispondente dal file branding.xml.

file	Uso	Origine contenuto visualizzata
homepage.htm	Si tratta di una pagina che visualizza il contenuto attualmente installato e qualsiasi altro messaggio appropriato per presentare all'utente il contenuto. Questo file ha l'attributo di metadati aggiuntivo "Microsoft.Help.Id" content="-1" che inserisce il contenuto nella parte superiore del sommario del contenuto locale.
	<META_HOME_PAGE_TITLE_ADD/>	Branding.xml, tag <HomePageTitle>
	<HOME_PAGE_INTRODUCTION_edizione Standard CTION_ADD/>	Branding.xml, contrassegna <HomePageIntroduction>
	<HOME_PAGE_CONTENT_INSTALL_edizione Standard CTION_ADD/>	Branding.xml, contrassegnare <HomePageContentInstallText>
	<HOME_PAGE_BOOKS_INSTALLED_edizione Standard CTION_ADD/>	Sezione titolo Branding.xml tag<HomePageInstalledBooks>, i dati generati dall'applicazione, <HomePageNoBooksInstalled> quando non sono installati libri.
	<HOME_PAGE_edizione Standard TTINGS_edizione Standard CTION_ADD/>	Sezione titolo Branding.xml tag <HomePageHelp Impostazioni>, testo <della sezione HomePageHelp Impostazioni Text>.
topiccorrupted.htm	Quando un argomento esiste nel set locale, ma per qualche motivo non può essere visualizzato (contenuto danneggiato).
	<META_TOPIC_CORRUPTED_TITLE_ADD/>	Branding.xml, tag <TopicCorruptedTitle>
	<TOPIC_CORRUPTED_edizione Standard CTION_ADD/>	Branding.xml, tag <TopicCorruptedViewOnlineText>
topicnotfound.htm	Quando un argomento non viene trovato nel set di contenuto locale, né disponibile online
	<META_TOPIC_NOT_FOUND_TITLE_ADD/>	Branding.xml, tag <TopicNotFoundTitle>
	<META_TOPIC_NOT_FOUND_ID_ADD/>	Branding.xml, tag <TopicNotFoundViewOnlineText> + <TopicNotFoundDownloadContentText>
	<TOPIC_NOT_FOUND_edizione Standard CTION_ADD/>	Branding.xml, tag <TopicNotFoundText>
contentnotinstalled.htm	Quando non è installato alcun contenuto locale per il prodotto.
	<META_CONTENT_NOT_INSTALLED_TITLE_ADD/>	Branding.xml, tag <ContentNotInstalledTitle>
	<META_CONTENT_NOT_INSTALLED_ID_ADD/>	Branding.xml, tag <ContentNotInstalledDownloadContentText>
	<CONTENT_NOT_INSTALLED_edizione Standard CTION_ADD/>	Branding.xml, tag <ContentNotInstalledText>

File CSS

Il pacchetto di personalizzazione del Visualizzatore della Guida di Visual Studio contiene due file CSS per supportare una presentazione coerente del contenuto della Guida di Visual Studio:

Branding.css : contiene elementi CSS per il rendering in cui SelfBranded=false
Printer.css : contiene elementi CSS per il rendering in cui SelfBranded=false

Branding.css file includono definizioni per la presentazione dell'argomento di Visual Studio . Si noti che il branding.css contenuto nel Branding_<locale.mshc> dal servizio del pacchetto può cambiare.

File grafici

Il contenuto di Visual Studio visualizza un logo di Visual Studio e altre immagini. Di seguito è riportato l'elenco completo dei file grafici nel pacchetto di personalizzazione di Visual Studio Help Viewer.

file	Uso	Esempi
clear.gif	Usato per eseguire il rendering dell'area collapsible
footer_slice.gif	Presentazione piè di pagina
info_icon.gif	Utilizzato durante la visualizzazione delle informazioni	Dichiarazione di non responsabilità
online_icon.gif	Questa icona deve essere associata ai collegamenti online
tabLeftBD.gif	Usato per eseguire il rendering del contenitore del frammento di codice
tabRightBD.gif	Usato per eseguire il rendering del contenitore del frammento di codice
vs_logo_bk.gif	Usato per i normali riferimenti al logo a contrasto come definito in Branding.xml tag <LogoFileName>. Per i prodotti Visual Studio, il nome del logo è vs_logo_bk.gif.
vs_logo_wh.gif	Usato per i riferimenti al logo a contrasto elevato come definito nel tag <Branding.xml LogoFileNameHC>. Per i prodotti Visual Studio, il nome del logo è vs_logo_wh.gif.
ccOff.png	Elemento grafico di didascalia
ccOn.png	Elemento grafico di didascalia
ImageSprite.png	Usato per eseguire il rendering dell'area collapsible	elemento grafico espanso o compresso

Distribuire un set di argomenti

Si tratta di un'esercitazione semplice e rapida per la creazione di un set di distribuzione di contenuto help viewer costituito da un file MSHA e dal set di cab o MSHC contenenti gli argomenti. MSHA è un file XML che descrive un set di file CAB o MSHC. Help Viewer può leggere MSHA per ottenere un elenco di contenuto (il .CAB o . File MSHC) disponibili per l'installazione locale.

Si tratta solo di un'introduzione che descrive lo schema XML molto semplice per L'MSHA help viewer. Di seguito è riportato un esempio di implementazione di questa breve panoramica e di esempio helpContentSetup.msha.

Il nome di MSHA, ai fini di questa guida di base, è HelpContentSetup.msha (il nome del file può essere qualsiasi elemento, con l'estensione . MSHA). HelpContentSetup.msha (esempio di seguito) deve contenere un elenco dei cab o MSHC disponibili. Il tipo di file deve essere coerente all'interno di MSHA (non supporta una combinazione di tipi di file MSHA e CAB). Per ogni CAB o MSHC, dovrebbe essere presente una <classe div="package">...</div> (vedere l'esempio seguente).

Nota: nell'esempio di implementazione seguente è stato incluso il pacchetto di personalizzazione. Questa operazione è fondamentale da includere per ottenere gli elementi e i comportamenti di contenuto necessari per il rendering del contenuto di Visual Studio.

File HelpContentSetup.msha di esempio: (sostituire "content set name 1" e "content set name 2" e così via con i nomi dei file.

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>.

Creare una cartella locale, ad esempio "C:\SampleContent"
Per questo esempio si useranno i file MSHC per contenere gli argomenti. MsHC è un file ZIP con l'estensione del file modificato da .zip a . MSHC.
Creare il file HelpContentSetup.msha seguente come file di testo (blocco note usato per creare il file) e salvarlo nella cartella precedente annotata (vedere il passaggio 1).

La classe "Branding" esiste ed è univoca. La personalizzazione di mshc è inclusa in questa guida di base in modo che il contenuto installato abbia informazioni personalizzate e i comportamenti del contenuto contenuti nei controller di dominio di gestione di windows avranno gli elementi di supporto appropriati contenuti nel pacchetto di personalizzazione. Senza questo, gli errori si verificano quando il sistema cerca gli elementi di supporto che non fanno parte del contenuto copiato (installato).

Per ottenere il pacchetto di personalizzazione di Visual Studio, copiare il file Branding_en-US.mshc in C:\Programmi (x86)\Microsoft Help Viewer\v2.3\ nella cartella di lavoro.

<html>
<head />
<body class="vendor-book">
<div class="details">
<span class="vendor">Your Company</span>
<span class="locale">en-us</span>
<span class="product">Your Company Help Content</span>
<span class="name">Your Company Help Content</span>
</div>
<div class="package-list">
<div class="package">
<span class="name">Your_Company _Content_Set_1</span>
<span class="deployed">True</span>
<a class="current-link" href="Your_Company _Content_Set_1.mshc">Your_Company _Content_Set_1.mshc </a>
</div>
<div class="package">
<span class="name">Your_Company _Content_Set_2</span>
<span class="deployed">True</span>
<a class="current-link"href=" Your_Company _Content_Set_2.mshc "> Your_Company _Content_Set_2.mshc </a>
</div>
<div class="package">
<span class="packageType">branding</span>
<span class="name">Branding_en-US</span>
<span class="deployed">True</span>
<a class="current-link" href="Branding_en-US.mshc">Branding_en-US.mshc</a>
</div>
</div>
</body>
</html>

Riepilogo

L'uso e l'estensione dei passaggi precedenti consentirà ai vsp di distribuire i set di contenuti per il Visualizzatore della Guida di Visual Studio.

Aggiungere la Guida alla shell di Visual Studio (integrata e isolata)

Introduzione

Questa procedura dettagliata illustra come incorporare il contenuto della Guida in un'applicazione Di Visual Studio Shell e quindi distribuirlo.

Requisiti

Visual Studio 2013
Redist della shell isolata di Visual Studio 2013

Sintesi

Visual Studio 2013 Shell è una versione dell'IDE di Visual Studio 2013 in cui è possibile basare un'applicazione. Tali applicazioni contengono la shell isolata insieme alle estensioni create dall'utente. Usare i modelli di progetto Isolated Shell, inclusi in Visual Studio 2013 SDK, per compilare le estensioni.

I passaggi di base per la creazione di un'applicazione basata su Isolated Shell e la relativa Guida:

Ottenere Visual Studio 2013 ISO Shell redistributable (download Microsoft).
In Visual Studio creare un'estensione della Guida basata su Shell isolata, ad esempio l'estensione della Guida di Contoso descritta più avanti in questa procedura dettagliata.
Eseguire il wrapping dell'estensione e della shell ISO ridistribuibile in un'identità del servizio gestito di distribuzione (un'installazione dell'applicazione). Questa procedura dettagliata non include un passaggio di installazione.

Creare un archivio contenuto di Visual Studio. Per lo scenario Integrated Shell, modificare Visual Studio12 con il nome del catalogo prodotti come indicato di seguito:

Crea cartella C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15.
Creare un file denominato CatalogType.xml e aggiungerlo alla cartella . Il file deve contenere le righe di codice seguenti:
```
<?xml version="1.0" encoding="UTF-8"?>
<catalogType>UserManaged</catalogType>
```

Definire l'archivio contenuto nel Registro di sistema. Per Integrated Shell modificare VisualStudio15 con il nome del catalogo prodotti:

HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15

Chiave: Valore stringa LocationPath: C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15\
HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15\en-US

Chiave: Valore stringa CatalogName: Documentazione di Visual Studio 2013

Creare il progetto

Per creare un'estensione Isolated Shell:

In Visual Studio, in File scegliere Nuovo progetto, in Altri tipi di progetto scegliere Estendibilità e quindi scegliere Visual Studio Shell isolato. Assegnare al progetto ContosoHelpShellil nome ) per creare un progetto di estendibilità basato sul modello Di shell isolata di Visual Studio.
In Esplora soluzioni, nel progetto ContosoHelpShellUI aprire ApplicationCommands.vsct nella cartella File di risorse. Assicurarsi che questa riga sia impostata come commento (cercare "No_Help"): 
Scegliere il tasto F5 per compilare ed eseguire Debug. Nell'istanza sperimentale dell'IDE Isolated Shell scegliere il menu ? Assicurarsi che vengano visualizzati i comandi Visualizza guida, Aggiungi e Rimuovi contenuto della Guida e Imposta preferenza guida.
In Esplora soluzioni, nel progetto ContosHelpShell, nella cartella Personalizzazione shell aprire ContosoHelpShell.pkgdef. Per definire il catalogo della Guida di Contoso, aggiungere le righe seguenti:
```
 [$RootKey$\Help]
"Product"="Contoso"
"Catalog"="Contoso"
"Version"="100"
"BrandingPackage"="ContosoBrandingPackage.mshc"
```

In Esplora soluzioni, nel progetto ContosHelpShell, nella cartella Personalizzazione shell aprire ContosoHelpShell.Application.pkgdef. Per abilitare la Guida sensibile al contesto, aggiungere le righe seguenti:

// F1 Help Provider

[$RootKey$\HelpProviders\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
"Name"="13407"
"Package"="{DA9FB551-C724-11d0-AE1F-00A0C90FFFC3}"
@="Help3 Provider"
[$RootKey$\HelpProviders]
@="{C99BDC23-FF29-46bf-9658-ADD634CCAED8}"
[$RootKey$\Services\{C99BDC23-FF29-46bf-9658-ADD634CCAED8}]
"Name"="Help3 Provider"
@="{4A791146-19E4-11D3-B86B-00C04F79F802}"

In Esplora soluzioni scegliere la voce di menu di menu Proprietà dal menu di scelta rapida della soluzione ContosoHelpShell. In Proprietà di configurazione selezionare Configuration Manager. Nella colonna Configurazione modificare ogni valore "Debug" in "Release".
Compilare la soluzione. Verrà creato un set di file in una cartella di versione, che verrà usata nella sezione successiva.

Per testarlo come se fosse stato distribuito:

Nel computer in cui si distribuisce Contoso installare la shell ISO scaricata (da sopra).
Creare una cartella in \\Programmi (x86)\e denominarla Contoso.
Copiare il contenuto dalla cartella di rilascio ContosoHelpShell alla cartella \\Programmi (x86)\Contoso\.
Avviare l'editor del Registro di sistema scegliendo Esegui nel menu Start e immettendo Regedit. Nell'editor del Registro di sistema scegliere File e quindi Importa. Passare alla cartella del progetto ContosoHelpShell. Nella sottocartella ContosoHelpShell scegliere ContosoHelpShell.reg.
Creare un archivio contenuto:

Per la shell ISO : creare un archivio contenuto Contoso C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\ContosoDev12

Per Visual Studio 2013 Integrated Shell, creare la cartella C:\ProgramData\Microsoft\HelpLibrary2\Catalogs\VisualStudio15
Creare CatalogType.xml e aggiungere all'archivio contenuto (passaggio precedente) contenente:
```
<?xml version="1.0" encoding="UTF-8"?>
<catalogType>UserManaged</catalogType>
```
Aggiungere le chiavi del Registro di sistema seguenti:

HKLM\SOFTWARE\Wow6432Node\Microsoft\Help\v2.3\Catalogs\VisualStudio15Key: Valore stringa LocationPath:

Per la shell ISO:

C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15

Shell integrata di Visual Studio 2013:

C:ProgramDataMicrosoftHelpLibrary2CatalogsVisualStudio15en-US

Chiave: Valore stringa CatalogName: Documentazione di Visual Studio 2013. Per ISO Shell, questo è il nome del catalogo.
Copiare il contenuto (cab o MSHC e MSHA) in una cartella locale.
Esempio di riga di comando di Shell integrata per il test dell'archivio contenuto. Per ISO Shell modificare il catalogo e avviare i valori di App in base alle esigenze in modo che corrispondano al prodotto.

"C:\Programmi (x86)\Microsoft Help Viewer\v2.3\HlpViewer.exe" /catalogName VisualStudio15 /helpQuery method="page&id=ContosoTopic0" /launchingApp Microsoft,VisualStudio,12.0
Avviare l'applicazione Contoso (dalla radice dell'app Contoso). In SHELL ISO scegliere la voce di menu ? e modificare l'opzione Imposta preferenza guida per l'uso della Guida locale.
Nella shell scegliere la voce di menu ? , quindi Visualizza guida. Verrà avviato il visualizzatore della Guida locale. Scegliere la scheda Gestisci contenuto . In Origine installazione scegliere il pulsante di opzione Disco . Scegliere il pulsante ... e passare alla cartella locale contenente il contenuto contoso (copiato nella cartella locale nel passaggio precedente). Scegliere HelpContentSetup.msha. Contoso dovrebbe ora essere visualizzato come libro nelle selezioni dei libri. Scegliere Aggiungi e quindi scegliere il pulsante Aggiorna (angolo in basso a destra).
Nell'IDE contoso scegliere la chiave F1 per testare la funzionalità F1.

Risorse aggiuntive

Per l'API di runtime, vedere API della Guida di Windows.

Per altre informazioni su come sfruttare l'API della Guida, vedere Esempi di codice help viewer.

È possibile inviare suggerimenti sulle funzionalità nella community degli sviluppatori.