Documentazione/ContenutoMultimedialeAiuto

From The Document Foundation Wiki
Jump to: navigation, search
This page is a translated version of the page Documentation/HelpRichContents and the translation is 100% complete.

Other languages:
dansk • ‎English • ‎italiano

Le pagine del nuovo Aiuto in linea di LibreOffice possono visualizzare ed essere collegate a contenuti multimediali come dei video o dei file di esempio reali. L'Aiuto non in linea (in locale) per com'è stato progettato non dispone di questa funzionalità.

L'aggiunta di multimedia ed i altri tipi di file ha l'intento di essere complementare alla più esaustiva, ma spesso difficile, descrizione testuale. In una pagina di aiuto sono importanti entrambi. La descrizione testuale è un modo per illustrare il funzionamento di di una funzione, mentre i file rappresentano l'implementazione pratica della descrizione. Quando si verifica una discrepanza, o c'è un bug nel programma, oppure la descrizione presente nella pagina dev'essere aggiornata.

Video esterni

Per inserire un video aggiungete, all'interno di un paragrafo (<paragraph>) del file di aiuto, un semplice tag <object> con gli opportuni parametri

<paragraph role="paragraph" id="par_id1234567" xml-lang="it-IT">
<object data="https://www.youtube-nocookie.com/embed/3KC0ZdcA6s8?rel=0" 
id="vid_id61521568603544" 
type="video/youtube" 
width="560" 
height="315" />
</paragraph>

Dove

  • data è l'URL del file all'interno del sistema di aiuto
  • type è il tipo del file, che dev'essere video/youtube
  • id è un identificativo univoco
  • width è la larghezza del video
  • height è la sua altezza.

Il tipo di file qui indicato (video/youtube) non vi obbliga ad usare i servizi di You Tube. Il video può essere ospitato su server esterni come You Tube (testato) o qualsiasi altro (non testato).

ExampleVideoHelp.png

Descrizione tecnica

L'HTML generato da questo tipo, all'interno del foglio di stile che ne cura trasformazione, è definito in un tag <iframe>:

<xsl:when test="starts-with(@type,'video/youtube')">
  <xsl:if test="$online">
      <div id="mediadiv">
         <iframe id="{@id}" src="{@data}" width="{$width}" height="{$height}" frameborder="0" allowfullscreen="true"></iframe>
      </div>
   </xsl:if>
</xsl:when>

ciò significa che quando il tipo è video/youtube e l'aiuto è in linea, il video sarà contenuto in una cornice <iframe> inserita in un tag <div> con stile .mediadiv

File ODF nelle pagine di aiuto

I file in formato OpenDocument inseriti nel sistema di aiuto funzionano sia nella versione in locale, sia nella versione in linea delle nuove pagine di Aiuto.

Gli autori dell'Aiuto ora possono aggiungere degli elementi <object> con tipo type="application/vnd.oasis.opendocument.*" come

  • application/vnd.oasis.opendocument.text (per i testi)
  • application/vnd.oasis.opendocument.spreadsheet (per i fogli di calcolo)
  • application/vnd.oasis.opendocument.drawing (per i disegni)
  • application/vnd.oasis.opendocument.presentation (per le presentazioni)
  • application/vnd.oasis.opendocument.formula (per le formule)
  • application/vnd.oasis.opendocument.database (per i database)

Dato che le pagine di aiuto sono per la maggior parte testuali, non rappresentano il modo migliore di illustrate come funziona una determinata funzione. Poter disporre di un vero file in formato opendocument, da scaricare direttamente dall'Aiuto, costituisce un passo che consente di vedere in pratica un esempio concreto.

L'implementazione di un oggetto OpenDocument è semplice. Inserite semplicemente un tag <object> specificando negli attributi: il percorso del file, il tipo corrente in forma di OpenDocument MIME type che sia valido e un id, che è una stringa casuale.

<object data="media/files/scalc/imtrigon.ods"
id="ods_id61521568603544" 
type="application/vnd.oasis.opendocument.spreadsheet" /> 

Dove

  • data è l'URL del file nel sistema di aiuto
  • type è il MIME type del file, come sopra
  • id è un identificativo univoco

Nella pagina che viene generata il risutato è un'icona di collegamento alla pagina di download:

ExampleFileIcon.png

Descrizione tecnica

La trasformazione dei file ODF in HTML5 viene eseguita da questo modello:

<xsl:when test="@type='application/vnd.oasis.opendocument.spreadsheet'">
       <a class="objectfiles" href="{concat($target,@data)}"><img src="{concat($target,'media/navigation/libo-calc.svg')}" width="25px" height="30px"></img></a>
</xsl:when>

il che significa che viene inserita l'icona del MIME type con un collegamento al file presente nell'archivio.

Cosa aggiungere nelle pagine di aiuto

L'aggiunta di contenuti multimediali nelle pagine dell'aiuto è un argomento destinato agli autori dell'aiuto stesso.