Δόμηση πρόσθετης λειτουργίας βοήθειας
Στο παράδειγμα αυτό, υποθέτουμε ότι ο συντάκτης τεκμηρίωσης σας έχει ήδη προμηθεύσει με την αδιαμόρφωτη τεκμηρίωση με τη μορφή αρχείων HTML. Το επίπεδο ανάλυσης και η δομή των αρχείων αυτών εξαρτάται πλήρως από την ομάδα τεκμηρίωσης. Μόλις παραδοθεί η τεκμηρίωση, η ρύθμιση της πρόσθετης λειτουργίας και των θεμάτων μπορεί να γίνει ανεξάρτητα.
Ξεκινούμε με την υπόθεση ότι η τεκμηρίωση έχει ήδη παρασχεθεί στην ακόλουθη διακλάδωση.
html
concepts/
concept1.html
concept1_1.html
concept1_2.html
tasks/
task1.html
task2.html
task3_1.html
task3_2.html
ref/
ref1.html
ref2.html
Υποθέτουμε ότι το όνομα της πρόσθετης λειτουργίας είναι com.example.helpexample.
Το πρώτο βήμα είναι η δημιουργία ενός καταλόγου πρόσθετης λειτουργίας, com.example.helpexample κάτω από τον κατάλογο plugins της πλατφόρμας. Η υποδιακλάδωση doc\ που εμφανίζεται παραπάνω πρέπει να αντιγραφεί στον κατάλογο.
Οι πρόσθετες λειτουργίες τεκμηρίωσης χρειάζονται μια δήλωση όπως οι πρόσθετες λειτουργίες κώδικα. Η ακόλουθη μορφοποίηση ορίζει την πρόσθετη λειτουργία τεκμηρίωσης.
<?xml version="1.0" ?>
<plugin name="Online Help Sample"
id="com.example.helpexample"
version="1.0"
provider-name="MyExample" />