Alessandro Del Sole's Blog

{ A programming space about Microsoft® .NET® }
posts - 1909, comments - 2047, trackbacks - 352

My Links

News

Your host

This is me! Questo spazio è dedicato a Microsoft® .NET®, di cui sono molto appassionato :-)

Cookie e Privacy

Microsoft MVP

My MVP Profile

Microsoft Certified Professional

Microsoft Specialist

Xamarin Certified Mobile Developer

Il mio libro su VB 2015!

Pre-ordina il mio libro su VB 2015 Pre-ordina il mio libro "Visual Basic 2015 Unleashed". Clicca sulla copertina per informazioni!

Il mio libro su WPF 4.5.1!

Clicca sulla copertina per informazioni! E' uscito il mio libro "Programmare con WPF 4.5.1". Clicca sulla copertina per informazioni!

These postings are provided 'AS IS' for entertainment purposes only with absolutely no warranty expressed or implied and confer no rights.
If you're not an Italian user, please visit my English blog

Le vostre visite

I'm a VB!

Guarda la mia intervista a Seattle

Follow me on Twitter!

Altri spazi

GitHub
I miei progetti open-source su GitHub

Article Categories

Archives

Post Categories

Image Galleries

Privacy Policy

SandCastle HelpFile Builder e la localizzazione italiana

Vi ho parlato spesso di SandCastle HelpFile Builder, interfaccia grafica gratuita che utilizza Microsoft SandCastle per generare la documentazione per i propri sorgenti creando file della guida compilati in formato .Chm o .HxS. Tra l'altro, il capitolo 8 del mio libro su VB 2005 fa uso di questo strumento per illustrare la creazione in formato binario di tale documentazione.

Personalmente non ho mai avuto difficoltà nel generare documentazione in lingua italiana, probabilmente per le edizioni del software da me installato, tutto in italiano. Ho ricevuto alcune e-mail di chiarimento dal sig. Francesco Benini, nelle quali mi veniva rappresentata l'impossibilità di generare documentazione in italiano, al contrario solo in inglese. Dopo vari tentativi e leggendo la documentazione relativa alla nuova versione di SHFB, Francesco è riuscito a generare la documentazione per i propri sorgenti utilizzando una procedura manuale. Francesco, inoltre, ha realizzato una mini-guida step-by-step e che ha deciso di condividere con tutti voi per il tramite del mio blog. Io mi sono limitato a revisionare e riscrivere la guida predisposta da Francesco secondo uno stile più adatto alla pubblicazione su blog :-). La procedura consiste in quattro fasi, che riporto di seguito:

Prima fase

 

Il primo passaggio è quello che riguarda l’individuazione dei file di SandCastle che dovremo poi copiare in una apposita cartella e che successivamente dovremo tradurre.

 

I percorsi sotto indicati si riferiscono all’installazione di  Microsoft SandCastle distribuita separatamente dal Visual Studio 2005 SDK. Utilizzare SandCastle come prodotto separato da VS 2005 SDK è buona pratica con SandCastle Help File Builder, per via di problemi nel rilevamento dei percorsi standard.

 

È possibile creare la documentazione secondo tre stili: VS2005, Prototype e Hana. Ciascuno stile è costituito dai seguenti file XML: 

  • conceptual_content.xml
  • reference_content.xml
  • shared_content.xml
  • token_content.xml 

che risiedono, rispettivamente, nelle cartelle C:\Programmi\Sandcastle\Presentation\vs2005\Content, C:\Programmi\Sandcastle\Presentation\Prototype\Content e C:\Programmi\Sandcastle\Presentation\hana\Content

 

La cartella Content di ciascuno stile contiene i file XML sopra elencati. Una volta stabilito lo stile da utilizzare, potete impostarlo tramite la proprietà PresentationStyle che, per l’appunto, può essere impostata su Hana-Prototype-vs2005. SHFB utilizza, per default, lo stile Prototype

 

Seconda fase

 

Il secondo passaggio è quello di creare una cartella specifica per la lingua desiderata, all’interno della cartella relativa allo stile che volete utilizzare.

 

Ipotizzando di voler creare la documentazione secondo lo stile di Visual Studio 2005, spostatevi nella cartella C:\Programmi\Sandcastle\Presentation\vs2005\Content e create una sottocartella chiamata it-IT per l’italiano.

 

All’interno di questa cartella devono essere copiati i 4 file .xml della cartella ..\Content. Fatto questo, è necessario tradurre tutto il necessario dall’inglese alla lingua desiderata (nel nostro caso l’italiano).

Ponete particolare attenzione al file shared_content.xml dove trovate il seguente tag XML:

 

<!-- locale -->

            <item id="locale">en-us</item>

 

In questo tag, il valore dell’elemento en-us va sostituito con it-IT

 

 

Terza fase

 

SandCastle Help File Builder fornisce alcuni file che è possibile utilizzare per creare i file della guida nella lingua desiderata, che si trovano nella cartella C:\Programmi\EWSoftware\Sandcastle Help File Builder\SharedContent. I file di interesse per la lingua italiana hanno terminazione _it_IT. Ad esempio, per l’italiano, c’è un file chiamato SharedBuilderContent_it-IT.xml. Copiatelo nella cartella ..\Content\it-It precedentemente creata e rinominatelo con l’identificatore per la lingua locale (SharedBuilderContent_it-IT.xml diventerà 0x0410.xml).

 

Al seguente URL della libreria MSDN potete trovare l’elenco completo degli identificatori delle lingue: http://msdn2.microsoft.com/en-us/library/ms776260.aspx

 

 

Quarta fase

 

Fatto questo, possiamo creare un nuovo progetto in SHFB. Alla proprietà Language assegnate il valore Italiano (Italia).

La proprietà PresentationStyle va  impostata sullo stile che avete deciso di adottare e quindi che avete tradotto. Infine, impostate tutte le altre proprietà del progetto di SHFB di vostro interesse ed avviate la compilazione, ponendo attenzione alla sezione chiamata Output.

Nella finestra di log nella parte sottostante di SHFB, questo è il messaggio che deve necessariamente comparire: “Generating shared content files (it-IT, Italiano (Italia))...”

 

In caso contrario, si sono verificati dei problemi con i file XML tradotti e il risultato sarà ancora la documentazione in lingua inglese.

Ringrazio ancora Francesco per la disponibilità a voler condividere la sua esperienza, certo che potrà tornare utile a molti di voi.

Alessandro

Print | posted on venerdì 2 novembre 2007 23:14 | Filed Under [ Help Authoring ]

Powered by:
Powered By Subtext Powered By ASP.NET