Panoramica della Guida aggiornabile

Questo documento fornisce un'introduzione di base alla progettazione e al funzionamento della funzionalità guida aggiornabile di PowerShell. È progettato per gli autori di moduli e altri utenti che forniscono argomenti della Guida di Windows PowerShell agli utenti.

Introduzione

Gli argomenti della Guida di PowerShell sono parte integrante dell'esperienza di PowerShell. Analogamente ai moduli di PowerShell, gli argomenti della Guida vengono continuamente aggiornati e migliorati dagli autori e dai contributi della community degli utenti di PowerShell.

La funzionalità Guida aggiornabile introdotta in Windows PowerShell 3.0 garantisce che gli utenti abbiano le versioni più recenti degli argomenti della Guida al prompt dei comandi, anche per i comandi di PowerShell predefiniti, senza scaricare nuovi moduli o eseguire Windows Update. La Guida aggiornabile semplifica l'aggiornamento fornendo cmdlet che scaricano le versioni più recenti degli argomenti della Guida da Internet e li installano nelle sottodirectory corrette nel computer locale dell'utente. Anche gli utenti protetti da firewall possono usare i nuovi cmdlet per ottenere informazioni aggiornate da una condivisione file interna.

La Guida aggiornabile è completamente supportata da tutti i moduli di Windows PowerShell in Windows 8 e Windows Server 2012 e le relative funzionalità sono disponibili per tutti gli autori di moduli di Windows PowerShell. La Guida aggiornabile supporta solo file della Guida basati su XML. Non supporta la Guida basata su commenti.

La Guida aggiornabile include le funzionalità seguenti.

• Il cmdlet Update-Help, che determina se gli utenti hanno i file della Guida più recenti per un modulo e, in caso contrario, scarica i file della Guida più recenti da Internet, li decomprime e li installa nelle sottodirectory del modulo corrette nel computer dell'utente. Gli utenti possono usare il cmdlet Get-Help per visualizzare immediatamente gli argomenti della Guida appena installati. Non è necessario riavviare PowerShell.

• Il cmdlet Save-Help, che scarica i file della Guida più recenti da Internet e li salva in una directory del file system. Gli utenti possono usare il cmdlet Update-Help per ottenere i file della Guida dalla directory del file system e decomprimerli e installarli nelle sottodirectory del modulo nel computer dell'utente. Il cmdlet Save-Help è progettato per gli utenti con accesso a Internet limitato o senza accesso a Internet e per le aziende che preferiscono limitare l'accesso a Internet.

• Guida per un modulo. I file della Guida per un modulo vengono gestiti e recapitati come unità, in modo che gli utenti possano ottenere tutti i file della Guida per i moduli usati. La Guida aggiornabile è supportata solo per i moduli, non per gli snap-in di Windows PowerShell.

• Versione supporta. La Guida aggiornabile usa quattro posizioni standard (N1. N2. N3. N4) numeri di versione. La Guida aggiornabile scarica i file della Guida quando il numero di versione dei file della Guida nel computer dell'utente (o nella directory Save-Help) è inferiore al numero di versione dei file della Guida nel percorso Internet.

• supporto multilingue. La Guida aggiornabile supporta i file della Guida del modulo in più impostazioni cultura dell'interfaccia utente. I nomi file della Guida aggiornabili includono codici linguistici standard, ad esempio "en-US" e "ja-JP", e i cmdlet Update-Help e Save-Help inserisce i file della Guida in sottodirectory specifiche della lingua della directory del modulo.

• guida generata automaticamente. Il cmdlet Get-Help visualizza la Guida di base per i comandi che non dispongono di file della Guida. La Guida generata automaticamente include la sintassi e gli alias dei comandi e le istruzioni per l'uso della Guida online e della Guida aggiornabile.

• guida avanzata online. L'accesso facilitato alla Guida online non richiede più file della Guida. Il parametro Online del cmdlet Get-Help ottiene ora l'URL di un argomento della Guida online dal valore della proprietà helpUri di un comando, se non riesce a trovare l'URL della Guida online in un file della Guida. È possibile popolare la proprietà HelpUri aggiungendo un attributo helpUri al codice dei cmdlet, delle funzioni e dei comandi CIM oppure usando la parola chiave della Guida basata su commenti .LINK nei flussi di lavoro e negli script.

  Per rendere aggiornabili i file della Guida, i moduli di Windows PowerShell in Windows non sono inclusi nei file della Guida. Gli utenti possono usare la Guida aggiornabile per installare i file della Guida della Guida e aggiornarli. Gli autori di altri moduli possono includere file della Guida nei moduli o ometterli. Il supporto per la Guida aggiornabile è facoltativo, ma consigliato.