Ankere

Du kan tenke på ankere som utvidelsespunktekvivalenten for brukerassistansedokumenter. På samme måte som komponenter bruker utvidelsespunkter for å tillate at andre komponenter utvider sin funksjonalitet, kan dokumenter bruke ankere for å tillate at andre komponenter utvider sitt brukerassistanseinnhold.

Tenk deg at dokumentasjonen for komponent A inneholder en liste over filformater som støttes. Hvis komponent B utvider As støtte til flere andre formater, kan du sette et anker i As liste, og utvide listen fra B. For eksempel:

   <p>Listen nedenfor viser de støttede formatene:</p>
   <ul>
      <li>Portable Network Graphics (.png)</li>
      <li>Joint Photographic Experts Group (.jpeg)</li>
      <li>Graphical Interchange Format (.gif)</li>
      
      <!-- Ekstraformater kommer her -->
      <anchor id="image_format_list"/>
   </ul>

Deretter kan komponent B gjøre et bidrag til ankeret for å legge til flere formater i listen.

Hvordan bidrar jeg med innhold til et anker?

Det avhenger av typen dokument. Du definerer vanligvis en utvidelse som peker på en XML-fil som inneholder innholdet som skal legges til. Følg linkene i delen nedenfor hvis du vil lære hvordan du skal gjøre det i den dokumenttypen du bruker:

Hvor kan jeg bruker ankere?

Nedenfor finner du en liste over dokumenttyper der det er mulig å bruke inkluderinger. Formatet for path-elementet i inkluderingen avhenger av den typen dokument du inkluderer fra. Som du ser i eksempelet ovenfor, er formatet for XHTML-hjelpedokumentene <plugin_id>/<path_to_file>/<element_id>". Se linkene nedenfor når du skal finne formatet for din dokumenttype.