Documentation/HelpRichContents {{Rename|Rigt indhold i hjælp}}.

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
Other languages:
dansk • ‎English • ‎italiano

LibreOffice's nye online Hjælpesider kan vise og linke til rigt indhold såsom videoer eller ægte eksempelfiler. Offline Hjælp (lokal hjælp) er ikke designet til at have denne funktionalitet.

Intentionen om at tilføje multimedier og andre filer er at supplere den præcise, men ofte besværlige, beskrivende tekst. Begge dele er vigtige på en hjælpeside. Den beskrivende tekst er vejen til at beskrive, hvordan en funktionalitet virker, og objektfilen er anvendelsen af beskrivelsen. Når der er uoverensstemmelse, så har enten softwaren en fejl eller siden behov for en opdatering.

Eksterne videoer

For at indsætte en video tilføjer du blot et <objekt>-mærke i en <paragraph> i hjælpefilen med passende indstillinger.

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

Hvor

  • data er filens URL i hjælpesystemet
  • type er filtypen og skal være video/youtube
  • id er et entydigt datanavn
  • bredde er videoens bredde
  • højde er dens højde

Typen der er specificeret her (video/youtube) tvinger dig ikke til at bruge You Tube-tjenester. Videoen kan ligge på en ekstern server som for eksempel You Tube (testet) eller en hvilken som helst anden (ikke testet).

ExampleVideoHelp.png

Teknisk beskrivelse

Den HTML, der gengiver denne type, er defineret i typografiarket Transformér og er et <iframe>-mærke.

<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>

hvilket betyder, at når typen er video/youtube og Hjælpen er online, vil en <iframe> indeholde videoen og vil være pakket i en <div> med typografien mediadiv.

ODF-filer på Hjælp-sider

OpenDocuments, der indsat i Hjælp-systemet virker i både offline- og online-versionen af de nye Hjælp-sider.

Forfatterne af Hjælp kan nu tilføje <object>-elementer med type="application/vnd.oasis.opendocument.*" såsom

  • application/vnd.oasis.opendocument.text
  • application/vnd.oasis.opendocument.spreadsheet
  • application/vnd.oasis.opendocument.drawing
  • application/vnd.oasis.opendocument.presentation
  • application/vnd.oasis.opendocument.formula
  • application/vnd.oasis.opendocument.database

Eftersom vore Hjælp-sider indeholder mest tekst, er de ikke bedst til at vise, hvordan en given funktion virker. At have en ægte opendocument-fil parat til at blive downloadet direkte fra Hjælp er et skridt på vejen til at se et rigtigt eksempel i funktion.

Inddragelsen af et OpenDokument-objekt er enkel. Indsæt blot et <object>-mærke, der specificerer filplaceringen i dataattributten, den rigtige type som et gyldigt OpenDocument MIME-type og et id, som er en tilfældig streng.

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

Hvor

  • data er filens URL i Hjælp-systemet
  • type er filens MIME-type, som ovenfor
  • id er en entydig identifikator

Resultatet på den gengivne side er et ikon med et link til at downloade siden:

ExampleFileIcon.png

Teknisk beskrivelse

Omformningen af ODF-objektfiler til HTML5 udføres i denne skabelon:

<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>

hvilket betyder, at et ikon af MIME-typen er indsat med et link til filen i depotet.

Hvad der skal tilføjes på Hjælp-siderne

Tilføjelse af rigt indhold på vore Hjælp-sider er et emne for forfatterne af Hjælp.