Hulp van docent voor applicaties en componenten toevoegen

U kunt eenvoudig hulp in het zijvenster maken voor tools in de Applicaties en componenten-database.

Het venster Docent in de catalogus Applicaties en componenten toont inhoud als u een item selecteert. De informatie is vooral nuttig voor het geven van advies aan uw gebruikers over het kiezen van de juiste component of het geven van aanwijzingen voordat een tool wordt uitgevoerd. Om deze functie ten volle te benutten, moeten gebruikers hun zijvensters zo rangschikken dat beide vensters zichtbaar zijn.

Selecteer de tool waarvoor u help wilt toevoegen in de catalogus Applicaties en componenten.
Klik het menu in het venster Docent en selecteer vervolgens Helpbestand toevoegen.

Er wordt een dialoogvenster geopend voor het maken van de benodigde bestanden volgens uw selecties.
Klik op Volgende en selecteer vervolgens een of meer talen.

Selecteer de talen die worden gebruikt als talen voor de gebruikersinterface van Tekla Structures in uw organisatie. Er moet een inhoudsbestand zijn voor elke taal, zelfs als u de inhoud niet vertaalt.
Klik op Volgende en selecteer vervolgens de map waarin u de gegenereerde bestanden wilt opslaan.

De bestanden kunnen in de model-, project-, bedrijfs- of systeemmap worden opgeslagen. De standaard zoekvolgorde voor mappen wordt gevolgd.

Als u bestanden wilt distribueren naar gebruikers, dan bevelen we aan dat u de bestanden opslaat in de project- of firmmap.
Klik op Maken.

Tekla Structures maakt een XML-bestand dat een koppeling tussen de tool in de Applicaties en componenten-database en een HTML-bestand voor de Help-inhoud definieert.

De HTML-bestanden worden opgeslagen in een mapstructuur die die bestanden scheidt in taalspecifieke mappen. Het XML-bestand en de hoofdmap voor de inhoud worden benoemd in overeenstemming met de identificator van het tool waarvoor de hulp is. U kunt bestanden tussen de toegestane opslag locaties kopiëren, maar de naam van de bestanden of mappen niet wijzigen of de mapstructuur wijzigen.
Bewerk de HTML-bestanden met inhoud in het tool van uw voorkeur, zoals Visual Basic, of vervang de bestanden door uw eigen HTML-bestanden met dezelfde bestandsnamen.

U kunt optioneel de hulpbestanden voor de docent toevoegen aan het .tsep-pakket voor uw extensie, zodat de hulp voor de docent automatisch wordt toegevoegd als gebruikers het .tsep-pakket installeren. U kunt het jokerteken (*) gebruiken in de het .xml-bestand van de projectdefinitie om alle bestanden toe te voegen aan de gespecificeerde map. Bijvoorbeeld:

<TargetPathVariables>
	<PathVariable Id="HelpDirectory" Value="%ENVDIR%\common\extensions\MyExtension\"/>
</TargetPathVariables>

<Component Id="ExampleExtension" Guid="4902568A-2195-4B38-BBA4-BEB56A2ABECF">
	<File Id="HelpFilesToCopy" Source="%TSEPDEFINITIONFILEFOLDER%\plugin\*" Target="%HelpDirectory%"/>
</Component>