Maak uw eigen documentatie beschikbaar in Easyplan

U kunt uw eigen documentatie beschikbaar maken in Easyplan door een XML bestand te bewerken - ribbon_help.xml, dat zich standaard in de map bevindt waarin Easyplan is geïnstalleerd - en daarin details van de documenten die u beschikbaar wilt maken in te voeren. Het is mogelijk om zowel documentatie van een specifiek type beschikbaar te maken - bijvoorbeeld, een PDF bestand, Microsoft Word document of URL - als om documenten van een bepaald type in een specifieke map beschikbaar te stellen. Bijvoorbeeld, wanneer u een aantal PDF bestanden beschikbaar wilt maken, kunt u ze alle in een enkele map zetten en specificeren dat alle PDF's binnen de map beschikbaar moeten worden gemaakt in Easyplan. U kunt ook aan ieder specifiek document-item een ander icoon toewijzen.

Elk document-item dat u beschikbaar stelt verschijnt op het Help tabblad van de Backstage view. U kunt ribbon_help.xml configureren om de documenten op het Help tabblad van de Backstage view in groepen weer te geven, die kunnen worden uit- en ingeklapt. Dit stelt u in staat om gerelateerde documenten logisch te groeperen. Wanneer u op een document klikt, opent deze in iedere applicatie die aan dat bestandstype is geassocieerd. Bijvoorbeeld, PDF bestanden zullen meestal openen in Adobe Acrobat.

Bewerken van ribbon_help.xml om uw eigen documentatie beschikbaar te maken

Het bestand Ribbon_help.xml bevindt zich standaard in de map waarin Easyplan is geïnstalleerd, alhoewel het mogelijk is om een andere locatie voor het bestand te specificeren - en een andere bestandsnaam, indien gewenst - door het register te wijzigen.

Om een andere locatie en een andere bestandsnaam voor het bestand ribbon_help.xml te specificeren, voeg een tekststring waarde met de naam DynHelpRibbon toe aan de HKEY_LOCAL_MACHINE\SOFTWARE\Asta\Easyplan\1.0\Misc\ register sleutel en voer de gewenste locatie en bestandsnaam in bij de waarde.

De locatie die u specificeert kan zich op een netwerk station bevinden.

Bijvoorbeeld, om de locatie te wijzigen naar C:\Powerproject XML Files\ en de bestandsnaam ongewijzigd te laten, maak de registersleutel DynHelpRibbon tekststring waarde aan en voer het volgende in:

C:\Powerproject XML File\ribbon_help.xml

Om de locatie te wijzigen naar T:\Powerproject XML Files\ en de bestandsnaam in asta_extra_docs_lint_modus.xml, maak de registersleutel DynHelpRibbon tekststring waarde aan en voer het volgende in:

T:\Powerproject XML Files\asta_extra_docs_lint_modus.xml

U kunt ribbon_help.xml bewerken met behulp van elke XML editing applicatie, of met eenvoudige applicatie zoals Kladblok. Het is aan te raden om een kopie te maken van het originele ribbon_help.xml bestand voordat u dit gaat bewerken, zodat u terug kunt keren naar het origineel wanneer dit nodig mocht zijn. Wanneer u ribbon_help.xml bewerkt, dan kun u nieuwe documentgroepen toevoegen, en bestaande documentgroepen bewerken of verwijderen.

Er worden automatisch backup kopieën van ribbon_help.xml gemaakt wanneer u Easyplanopstart, nadat u het XML bestand heeft aangepast. Deze kopieën worden opgeslagen in uw Documenten map, met de datum en de tijd waarop ze het laatst zijn gewijzigd toegevoegd aan de bestandsnaam. Bijvoorbeeld, wanneer u het ribbon_help.xml heeft aangepast op 14 November 2012 om 09:40, wordt de volgende keer dat u Easyplanopstart een kopie van het bestand aangemaakt met de naam ribbon_help 14-11-2012 09-40-14.xml (de laatste drie nummers in de bestandsnaam geven het tijdstip aan waarop het bestand voor het laatst is bewerkt). Deze automatische backup's zijn handig ook wanneer u de Easyplanupgrade naar een latere versies, namelijk toekomstige versies van Easyplankunnen aangepaste versies bezitten van ribbon_help.xml files waarbij het originele bestand dat u heeft aangepast wordt overschreven. U kun dan een backup kopie uit uw Documenten map gebruiken om de geüpdate versie te vervangen.

Illustratie van een voorbeeld van ribbon_help.xml

De volgende illustratie toont een voorbeeld van ribbon_help.xml bestand, zoals het wordt weergegeven als het wordt geopend in Kladblok. De illustratie bevat kleurcodes; Bekijk de tabel onder de illustratie voor uitleg over de verschillende elementen van het XML bestand:

Uitleg van de elementen van ribbon_help.xml

  De eerste regel van het XML bestand en de open en sluit tags van het hoofdelement, taskpanel. U mag de eerste regel, noch de open of sluit regels van het taskpanel element niet bewerken of verwijderen.
 

Het imagefile element. Ieder helpitem element, behalve de elementen van het Type "file", verwijzen naar een icoon binnen een imagestrip bestand. Het imagefile element is optioneel en kan worden ingevoegd wanneer u gebruik wilt maken van iconen in een imagestrip bestand van uzelf, in plaats van gebruik te maken van de iconen die standaard worden meegeleverd.

Wanneer u gebruik wilt maken van een imagestrip bestand van uzelf, dan moet dit element verwijzen naar een BMP bestand wat een strip van iconen bevat. Als de locatie niet is gespecificeerd dan wordt verondersteld dat het imagestrip bestand zich in dezelfde map bevindt als ribbon_help.xml. Ieder icoon in het bestand moet een afmeting hebben van 16 x 16 pixels (Dit geeft een bestand van een hoogte van 16 pixels bij een breedte van een meervoud van 16 pixels). Ongeacht welke kleur er is toegewezen aan de linkerbovenhoek pixel in het bestand wordt getoond als transparant wanneer het image wordt getoond.

De iconen die standaard worden meegeleverd worden hieronder weergegeven:
 

Een groep element met een ContentType gelijk aan "static", bevat een aantal ondergeschikte helpitem elementen. Ribbon_help.xml kan meerdere "static" groep elementen bevatten en ieder "static" groep element kan meerdere ondergeschikte helpitem elementen bevatten.

Iedere "static" groep element is gerelateerd aan een groep van documenten op het Help tabblad van de Backstage view.

"Static" groep elementen hebben de volgende attributen:

  • ContentType - een tekststring, altijd ingesteld op "static", die dit definieert als een groep op het Help tabblad van de Backstage view dat een aantal specifieke documenten bevat, in plaats van als een groep die alle documenten van een bepaald type in een specifieke map bevat .
  • Caption - een tekststring die de titel van de groep definieert zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van de groep op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Expanded - een getal dat aangeeft of de groep uitgeklapt (open) of ingeklapt (gesloten) moet worden weergegeven op het Help tabblad van de Backstage view. Stel dit in op "0" om de groep ingeklapt weer te geven; of op "1" om ze uitgeklapt weer te geven.
 

Een helpitem element binnen een groep element van het ContentType gelijk "static". Ieder helpitem element is gerelateerd aan een enkel document binnen de groep.

helpitem elementen hebben de volgende attributen:

  • Caption - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van her document op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Type - een tekststring het type document definieert: stel dit in op "file" om het helpitem element te koppelen aan een document van elk type; "help" om het te linken aan een CHM bestand; "mail" voor een hyperlink naar een email naar een specifiek email adres; of "url" voor een link naar een URL, ofwel op het Internet ofwel op een Intranet.
  • Filename - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "file", die de bestandsnaam definieert van het bestand en (optioneel) haar locatie. Wanneer de locatie niet is gespecificeerd, wordt verondersteld dat het document zich in dezelfde map bevind als ribbon_help.xml.
  • Help - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "help", die de bestandsnaam definieert van het CHM bestand en (optioneel) de locatie van het bestand en de topic binnen het CHM bestand dat zou moeten verschijnen wanneer het CHM bestand wordt geladen. Wanneer de locatie niet is gespecificeerd, wordt ervan uitgegaan dat het CHM bestand zich in dezelfde map bevindt als ribbon_help.xml.

    Wanneer u het topic wilt specificeren dat zou moeten verschijnen wanneer het CHM bestand wordt geladen, doet u dit door het toevoegen van twee dubbele punten achter de bestandsnaam van het CHM bestand, gevolgd door de locatie van het topic binnen het bron HTML Help project en de bestandsnaam van het topic , zoals in het volgende voorbeeld te zien is:

    Help="easyplan.chm::/HTML Topics/Other/Support.htm"

    Om deze informatie te kunnen verschaffen, moet u goed op de hoogte zijn van de interne structuur van het bron HTML Help project.
  • MailTo - een tekststring, dat alleen gebruikt wordt bij helpitem elementen van het Type "mail", die het e-mailadres definieert waar naartoe de email die verschijnt zou moeten worden gestuurd.
  • Url - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "url", die e URL of de webpagina definieert die zou moeten worden geopend.
  • IconId - een getal, die voor alle helpitem elementen gebruikt wordt, behalve voor die van het Type "file", die het icoontje aangeeft voor de afbeeldingen links van het document. Wanneer het XML bestand geen imagefile element bevat, worden de icoontjes uit de standaard afbeeldingen strook gebruikt; anders worden de icoontjes die in het imagefile element zijn gespecificeerd gebruikt. Stel dit in op "0" om te verwijzen naar het eerste icoontje in het bestand; op "1" voor het tweede; "2" voor het derde; enzovoorts.

U specificeert geen icoon voor helpitem elementen van het Type "file"; het icoon dat verschijnt aan de linkerzijde van ieder document wordt automatisch bepaald door het type van het document.
 

Een groep element van het ContentType "dynamic". Ribbon_help.xml kan meerdere "dynamic" groep elementen bevatten.

Ieder "dynamic" groep element is gerelateerd aan een groep van documenten op het Help tabblad van de Backstage view. De documenten die behoren tot de groep worden bepaald door de Folder (map) en de Extension (extensie) attributen, dan is het niet nodig om nieuwe individuele documenten te specificeren binnen een groep van dit type.

Ieder "dynamic" groep element kan optioneel één of meer ondergeschikte iteminfo elementen bevatten.

"Dynamic" groep elementen hebben de volgende attributen:

  • ContentType - een tekststring, altijd ingesteld op "dynamic", die dit definieert als een groep op het Help menu die alle documenten bevat van een bepaald type in een specifieke map, in plaats van als een groep dat een aantal specifieke documenten bevat.
  • Caption - een tekststring die de titel definieert van de groep zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Description - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van de groep op het Help tabblad van de Backstage view.
  • Folder - een tekststring die de locatie van de map definieert waarin de documenten die opgenomen moeten worden in de groep zich bevindt. Bijvoorbeeld, u kunt dit instellen op "C:\Mijn_Documentatie" of "T:\Powerproject Documenten". Dit attribuut is optioneel; wanneer u geen map specificeert, wordt verondersteld dat alle documenten zich in dezelfde map bevinden als waar ribbon_help.xml staat.
  • Extension - een tekststring die het type, of de types, documenten definieert in de gespecificeerde map om op te nemen in de groep. Wanneer u meer dan één type document specificeert, moet u de types scheiden met een puntkomma. Bijvoorbeeld, stel dit in op "pdf" om alle PDF bestanden erin op te nemen; "doc;docx" voor alle Microsoft Word documenten; "pdf;doc;docx" voor alle PDF bestanden en Microsoft Word documenten; enzovoorts.
  • Expanded - een getal dat aangeeft of de groep uitgeklapt (open) of ingeklapt (gesloten) moet worden weergegeven op het Help tabblad van de Backstage view. Stel dit in op "0" om de groep ingeklapt weer te geven; of op "1" om ze uitgeklapt weer te geven.

U specificeert geen iconen voor de documenten die behoren tot de "dynamic" groups; het icoon wat verschijnt aan de linkerzijde van ieder document wordt automatisch bepaald door het type van het document.
 

Een iteminfo element binnen een groep element met het ContentType gelijk aan "dynamic". Ieder iteminfo element bevat informatie dat is gerelateerd aan een enkel document binnen de groep. Omdat u de documenten binnen de "dynamic" groepen niet individueel specificeert, dan is het niet nodig om een nieuw iteminfo in te voeren voor de elementen, maar misschien wilt u dit wel doen om aan te geven op welke manier bepaalde documenten binnen de "dynamic" groep worden weergegeven.

iteminfo elementen hebben de volgende attributen:

  • Filename - een tekststring die de bestandsnaam definieert van het bestand waarover met aanvullende informatie.
  • Alias - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view - wanneer u geen alias specificeert, zullen documenten binnen "dynamische" groep elementen worden geïdentificeerd op het Help tabblad van de Backstage view via hun bestandsnaam.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van het document op het Help tabblad van de Backstage view.

Hoe het Help tabblad van de Backstage view eruit ziet met het ribbon_help.xml bestand van hierboven.

Wanneer het voorbeeld ribbon_help.xml bestand van hierboven wordt gebruikt, zal het Help tabblad van de Backstage view zoals in de onderstaande illustratie worden weergegeven (merk op dat de Handleidingen (Manuals) groep initieel ingeklapt wordt weergegeven):

De volgende secties beschrijven op welke manier u ribbon_help.xml moet aanpassen om specifieke documenten of groepen van documenten beschikbaar te maken in Easyplan.

Om een groep van specifieke documenten beschikbaar te stellen - bijvoorbeeld, specifieke PDF bestanden, Microsoft Word documenten of URL's - creëert u binnen ribbon_help.xml een groep element van het ContentType "static", vervolgens creëert u een aantal ondergeschikte helpitem elementen binnen het groep element, één helpitem element voor ieder document binnen de groep.

"Static" groep elementen hebben de volgende attributen:

  • ContentType - een tekststring, altijd ingesteld op "static", die dit definieert als een groep op het Help tabblad van de Backstage view dat een aantal specifieke documenten bevat, in plaats van als een groep die alle documenten van een bepaald type in een specifieke map bevat .
  • Caption - een tekststring die de titel van de groep definieert zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van de groep op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Expanded - een getal dat aangeeft of de groep uitgeklapt (open) of ingeklapt (gesloten) moet worden weergegeven op het Help tabblad van de Backstage view. Stel dit in op "0" om de groep ingeklapt weer te geven; of op "1" om ze uitgeklapt weer te geven.

Een voorbeeld "static" groep element (zonder enige ondergeschikte helpitem elementen) wordt hieronder weergegeven:

Zie de volgende secties voor details om de groep van individuele documenten te voorzien.

Om een specifiek bestand van welk type dan ook ter beschikking te stellen, moet u eerst binnen ribbon_help.xml een groep element creëren van het ContentType "static" (zoals hierboven beschreven), vervolgens creëert u een ondergeschikt helpitem element binnen het groep element dat gerelateerd is aan het bestand. Als het groep element waaraan u het bestand wilt relateren al bestaat, dan is het niet nodig om een nieuw groep element te creëren; u voegt eenvoudigweg een helpfile element toe aan het bestaande groep element.

helpitem elementen die gerelateerd zijn aan bestanden van welk type dan ook hebben de volgende attributen:

  • Caption - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van her document op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Type - een tekststring die het type document definieert: stel dit in op "file".
  • Filename - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "file", die de bestandsnaam definieert van het bestand en (optioneel) haar locatie. Wanneer de locatie niet is gespecificeerd, wordt verondersteld dat het document zich in dezelfde map bevind als ribbon_help.xml.

U specificeert geen iconen bij helpitem elementen van het Type "file"; het icoon dat verschijnt aan de linkerzijde van deze documenten wordt automatisch bepaald door het type van het document.

Twee voorbeelden van helpitem elementen die verwijzen naar specifieke bestanden met een "static" groep element worden hieronder getoond. Omdat er geen locatie is gespecificeerd in het Filename attribuut van het eerste voorbeeld helpitem element, wordt aangenomen dat het bestand zich in dezelfde map bevindt als ribbon_help.xml:

Om een specifiek CHM (HTML Help) ter beschikking te stellen, moet u eerst binnen ribbon_help.xml een groep element creëren van het ContentType "static" (zoals hierboven beschreven), vervolgens creëert u een ondergeschikt helpitem element binnen het groep element dat gerelateerd is aan het CHM bestand. Als het groep element waaraan u het CHM bestand wilt relateren al bestaat, dan is het niet nodig om een nieuw groep element te creëren; u voegt eenvoudigweg een helpfile element toe aan het bestaande groep element.

helpitem elementen die gerelateerd zijn aan bestanden van het CHM type hebben de volgende attributen:

  • Caption - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van her document op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Type - een tekststring die het type document definieert: stel dit in op "help".
  • Help - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "help", die de bestandsnaam definieert van het CHM bestand en (optioneel) de locatie van het bestand en de topic binnen het CHM bestand dat zou moeten verschijnen wanneer het CHM bestand wordt geladen. Wanneer de locatie niet is gespecificeerd, wordt ervan uitgegaan dat het CHM bestand zich in dezelfde map bevindt als ribbon_help.xml.

    Wanneer u het topic wilt specificeren dat zou moeten verschijnen wanneer het CHM bestand wordt geladen, doet u dit door het toevoegen van twee dubbele punten achter de bestandsnaam van het CHM bestand, gevolgd door de locatie van het topic binnen het bron HTML Help project en de bestandsnaam van het topic , zoals in het volgende voorbeeld te zien is:

    Help="easyplan.chm::/HTML Topics/Other/Support.htm"

    Om deze informatie te kunnen verschaffen, moet u goed op de hoogte zijn van de interne structuur van het bron HTML Help project.
  • IconId - een getal, die voor alle helpitem elementen gebruikt wordt, behalve voor die van het Type "file", die het icoontje aangeeft voor de afbeeldingen links van het document. Wanneer het XML bestand geen imagefile element bevat, worden de icoontjes uit de standaard afbeeldingen strook gebruikt; anders worden de icoontjes die in het imagefile element zijn gespecificeerd gebruikt. Stel dit in op "0" om te verwijzen naar het eerste icoontje in het bestand; op "1" voor het tweede; "2" voor het derde; enzovoorts.

Twee voorbeelden van helpitem elementen die verwijzen naar CHM bestanden van een "static"" groep element worden hieronder getoond. Omdat er geen locatie is gespecificeerd bij het Help attribuut van het tweede helpitem element, wordt aangenomen dat het CHM bestand zich in dezelfde map bevindt als ribbon_help.xml. Merk op dat het tweede voorbeeld helpitem element verwijst naar een specifiek onderdeel in het CHM bestand:

Merk op dat het ook mogelijk is om CHM (HTML Help) beschikbaar te stellen door gebruik te maken van helpitem elementen van het Type "file". Echter, wanneer u dit doet is het niet mogelijk om het Help attribuut te gebruiken dat hierboven is beschreven en te verwijzen naar een specifiek onderdeel in het CHM bestand dat moet worden getoond als het CHM bestand wordt gestart.

Om een hyperlink te maken die een email creëert naar een specifiek emailadres moet u eerst binnen ribbon_help.xml een groep element van het ContentType "static" (zoals hierboven beschreven), vervolgens creëert u een ondergeschikt helpitem element binnen het groep element dat is gerelateerd aan de hyperlink. Als het groep element waarbinnen u een hyperlink wilt toevoegen al bestaat, dan is het niet nodig om een nieuw groep element aan te maken; u kunt eenvoudigweg een helpfile element toevoegen aan het bestaande groep element.

helpitem elementen die gerelateerd zijn aan hyperlinks die email's creëren hebben de volgende attributen:

  • Caption - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van her document op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Type - een tekststring die het type document definieert: stel dit in op "mail".
  • MailTo - een tekststring, dat alleen gebruikt wordt bij helpitem elementen van het Type "mail", die het e-mailadres definieert waar naartoe de email die verschijnt zou moeten worden gestuurd.
  • IconId - een getal, die voor alle helpitem elementen gebruikt wordt, behalve voor die van het Type "file", die het icoontje aangeeft voor de afbeeldingen links van het document. Wanneer het XML bestand geen imagefile element bevat, worden de icoontjes uit de standaard afbeeldingen strook gebruikt; anders worden de icoontjes die in het imagefile element zijn gespecificeerd gebruikt. Stel dit in op "0" om te verwijzen naar het eerste icoontje in het bestand; op "1" voor het tweede; "2" voor het derde; enzovoorts.

Een voorbeeld helpitem element dat gerelateerd is aan een hyperlink waarbij een email wordt gecreëerd in een "static" groep element wordt hieronder weergegeven:

Om een link te maken naar een URL, moet u eerst in ribbon_help.xml een groep element creëren van het ContentType "static" (zoals hierboven beschreven), vervolgens creëert u een ondergeschikt helpitem element binnen het groep element dat is gerelateerd aan de hyperlink. Als het groep element waaraan u een hyperlink wilt toevoegen al bestaat, dan is het niet nodig om een nieuw groep element te creëren; u kunt eenvoudigweg een helpfile element toevoegen aan het bestaande groep element.

helpitem elementen die gerelateerd zijn aan URL hyperlinks hebben de volgende attributen:

  • Caption - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van her document op het Help tabblad van de Backstage view. Dit attribuut is optioneel.
  • Type - een tekststring die het type document definieert: stel dit in op "url".
  • Url - een tekststring, die alleen gebruikt wordt bij helpitem elementen van het Type "url", die e URL of de webpagina definieert die zou moeten worden geopend.
  • IconId - een getal, die voor alle helpitem elementen gebruikt wordt, behalve voor die van het Type "file", die het icoontje aangeeft voor de afbeeldingen links van het document. Wanneer het XML bestand geen imagefile element bevat, worden de icoontjes uit de standaard afbeeldingen strook gebruikt; anders worden de icoontjes die in het imagefile element zijn gespecificeerd gebruikt. Stel dit in op "0" om te verwijzen naar het eerste icoontje in het bestand; op "1" voor het tweede; "2" voor het derde; enzovoorts.

Een voorbeeld helpitem element dat is gerelateerd aan een URL hyperlink binnen een "static" groep element wordt hieronder weergegeven:

Om alle documenten van een bepaald type in een map beschikbaar te stellen - bijvoorbeeld, een aantal PDF bestanden - moet u eerst in ribbon_help.xml een groep element creëren van het ContentType "dynamic" waarmee de map wordt aangegeven waar de documenten zich bevinden en het type - of types - document om op te nemen in de groep.

"Dynamic" groep elementen hebben de volgende attributen:

  • ContentType - een tekststring, altijd ingesteld op "dynamic", die dit definieert als een groep op het Help menu die alle documenten bevat van een bepaald type in een specifieke map, in plaats van als een groep dat een aantal specifieke documenten bevat.
  • Caption - een tekststring die de titel definieert van de groep zoals het zou moeten verschijnen op het Help tabblad van de Backstage view.
  • Description - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van de groep op het Help tabblad van de Backstage view.
  • Folder - een tekststring die de locatie van de map definieert waarin de documenten die opgenomen moeten worden in de groep zich bevindt. Bijvoorbeeld, u kunt dit instellen op "C:\Mijn_Documentatie" of "T:\Powerproject Documenten". Dit attribuut is optioneel; wanneer u geen map specificeert, wordt verondersteld dat alle documenten zich in dezelfde map bevinden als waar ribbon_help.xml staat.
  • Extension - een tekststring die het type, of de types, documenten definieert in de gespecificeerde map om op te nemen in de groep. Wanneer u meer dan één type document specificeert, moet u de types scheiden met een puntkomma. Bijvoorbeeld, stel dit in op "pdf" om alle PDF bestanden erin op te nemen; "doc;docx" voor alle Microsoft Word documenten; "pdf;doc;docx" voor alle PDF bestanden en Microsoft Word documenten; enzovoorts.
  • Expanded - een getal dat aangeeft of de groep uitgeklapt (open) of ingeklapt (gesloten) moet worden weergegeven op het Help tabblad van de Backstage view. Stel dit in op "0" om de groep ingeklapt weer te geven; of op "1" om ze uitgeklapt weer te geven.

Een voorbeeld "dynamic" groep element wordt hieronder weergegeven:

Alhoewel u geen individuele documenten specificeert in een groep van dit type - de documenten behorende tot de groep worden bepaald door de Folder en de Extension attributen van het groep element zelf - wilt u misschien wel specificeren op welke manier één of meer van de documenten worden getoond. Voor ieder document dat wordt getoond kunt u een titel aangeven die wordt weergegeven op het Help tabblad van de Backstage view en de tekst die wordt weergegeven in een popup wanneer gebruikers de muisaanwijzer boven de titel van het document houden. Hiervoor dient u ondergeschikte iteminfo elementen aan te maken - één voor ieder document waarover u informatie wilt weergeven.

Iteminfo elementen hebben de volgende attributen:

  • Filename - een tekststring die de bestandsnaam definieert van het bestand waarover met aanvullende informatie.
  • Alias - een tekststring die de titel definieert van het document zoals het zou moeten verschijnen op het Help tabblad van de Backstage view - wanneer u geen alias specificeert, zullen documenten binnen "dynamische" groep elementen worden geïdentificeerd op het Help tabblad van de Backstage view via hun bestandsnaam.
  • Omschrijving - een tekststring die de tekst definieert die zou moeten verschijnen in een popup wanneer gebruikers de muisaanwijzer over de titel schuiven van het document op het Help tabblad van de Backstage view.

Een voorbeeld"dynamic" groep element met twee ondergeschikte helpitem elementen is hieronder weergegeven:

Verwante onderwerpen:

Introductie in de Backstage view