Sammanhangsberoende hjälp beskrivs genom att koppla det sammanhangsberoende IDt som deklareras i gränssnittskoden till en beskrivning och lista över länkar till relaterade avsnitt i onlinehjälpen. De kopplingarna görs inuti en XML-fil. Du kan skapa hur många XML-filer som innehåller sammanhangsberoende hjälpkopplingar som helst till varje insticksprogram. Beskrivningen och länkarna till varje sammanhangsberoende ID görs inuti <sammanhangsberoende> element i XML-filen. Varje sammanhangsberoende element kan ha ett valfritt <beskrivning>selement som används till att beskriva gränssnittsobjektet och valfritt antal <avsnitt>selement som är länkade till onlinedokumentationen.
Sedan 3.1 kan sammanhangsberoende element om så önskas ersätta standardrubriken som används till att visa sammanhangsberoende hjälpinformation i hjälpvyn.
<contexts> <context id="panic_button" title="Rubriken Larmknapp"> <description>Det här är larmknappen.</description> <topic href="tasks/pushing_the_panic_button.htm" label="Trycka på larmknappen"/> <topic href="reference/panic_button.htm" label="Referens till larmknappen"/> </context> ... </contexts>
När sammanhangen har beskrivits i XML-filen (eller filerna), är du redo att referera till de sammanhangsberoende filerna i insticksmanifestet. Observera att det sammanhangsberoende IDt inte är helt beskrivet ovan. Det är tillåtet, så länge den sammanhangsberoende filen finns med i manifestet för insticksprogrammet som definierade det sammanhangsberoende IDt. Med andra ord tolkas det sammanhangsberoende IDt som IDt för insticksprogrammet som tillhandahöll XML-filen.
Ett insticksprogram bidrar med sammanhangsberoende filer med hjälp av utökningspunkten org.eclipse.help.contexts.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" /> </extension>
Det går att referera till sammanhangsberoende filer från andra insticksprogram genom att inkludera attributet plugin. Det gör att du kan gruppera all dokumentation, inklusive sammanhangsberoende hjälp, i ett insticksprogram och hänvisa till den från insticksprogrammet för gränssnittskod eller något annat relaterat insticksprogram.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" plugin="com.example.helpExample" /> </extension>
Som du kan se har du stora valmöjligheter när du organiserar sammanhangen till en eller flera filer som finns i ett eller flera insticksprogram. Det viktigaste är att de sammanhangsberoende IDna i filerna tolkas rätt. Om du inte fullständigt har definierat ett sammanhangsberoende ID, så måste dulägga XML-innehållsfilerna i insticksprogrammet som deklarerade de sammanhangsberoende IDna. Om du använder sammanhangsberoende IDn som är helt definierade i XML-sammanhangsfilen, så kan du placera XML-filerna precis var du vill och välja helt fritt vilket insticksprogram som tillhandahåller sammanhangen.
Ett annat sätt att uppnå flexibilitet är möjligheten att tillhandahållasammanhangsberoende hjälp för samma sammanhangsberoende ID från flera insticksprogram. Det är användbart till exempel om det finns flera uppsättningar av insticksprogram med dokumentation som eventuellt finns installerade i en användares konfiguration. Det gör att varje insticksprogram för dokumentation kan deklarera sitt innehåll separat. Slutanvändaren får se det sammanfogade sammanhangsberoende hjälpinnehållet för alla insticksprogram somtillhandahållit sammanhang till gränssnittskontrollens ID.
Observera att fullständig sammanhangsberoende ID måste användas för gränssnittskontrollen, eftersom inga av insticksprogrammen för dokumentation deklarerat det sammanhangsberoende IDt. När flera insticksprogram tillhandahåller sammanhangsberoende hjälp till samma sammanhangsberoende ID, visas innehållet som finns definierat i insticksprogrammet som deklarerade sammanhanget (insticksprogrammet för gränssnittet) först. Ytterligare beskrivningar och länkar läggs inte till i någon särskild ordning.
Dynamiskt innehåll
Dynamiskt innehåll är tillgängligt för den sammanhangsberoende hjälpen i form av filter för avsnittslänkar till den sammanhangsberoende hjälpen. Du kan till exempel välja att en avsnittslänk visas i den sammanhangsberoende hjälpen endast i ett visst operativsystem.