Welcome to Telelogic Product Support
  Home Downloads Knowledgebase Case Tracking Licensing Help Telelogic Passport
Telelogic DOORS (steve huntington)
Decrease font size
Increase font size
Topic Title: dxl User Function
Topic Summary: Can't find the documentation on how to set up user functions
Created On: 16-Jun-2006 18:36
Status: Post and Reply
Linear : Threading : Single : Branch
Search Topic Search Topic
Topic Tools Topic Tools
Quick Reply Quick Reply
Subscribe to this topic Subscribe to this topic
E-mail this topic to someone. E-mail this topic
Bookmark this topic Bookmark this topic
View similar topics View similar topics
View topic in raw text format. Print this topic.
 16-Jun-2006 18:36
User is offline View Users Profile Print this message


Elizabeth Kensinger

Posts: 4
Joined: 12-Jun-2006

I have been looking through the documentation and the dxl directory structure and can't get any of the scripts I downloaded to show up or work for that matter.  Can someone direct me to the documentation on how to install user functions in the lib\dxl\user folders?
Report this to a Moderator Report this to a Moderator
 16-Jun-2006 21:23
User is offline View Users Profile Print this message


Louie Landale

Posts: 2070
Joined: 12-Sep-2002

[A] The DXL script files themselves need to have a particular format. You need two things "near the top" of the file, so you might as well put them at the top:
[1] A single line comment //. This line appears when someone browses the DXL library. Highly recommend you put the exact name of the script and a one line blurb.
[2] A block comment /* */. This text appears when someone single-clicks on a DXL when browsing the DXL library. I always repeat the name of the script and put a paragraph or two of details on what the script does.

Example:
// DisplayCurrentFolder.dxl - Displays the current DOORS folder.
/*
DisplayCurrentFolder.dxl displays the current folder to the user.
This is usually but not always the name of the folder displayed in the right hand
side of the DOORS explorer window.
*/

Folder fCurr = current
string NameFold
if (null fCurr) NameFold = "none"
else NameFold = fullName(fCurr)

infoBox("Current folder: " NameFold)
// end file DisplayCurrentFolder.dxl

The folder you want to display must contain two certain files. Both files have the exact same name as the folder; one is type ".hlp" and the other type ".idx". The first line of the *.hlp file is displayed when browsing the DXL file, the 2nd and additional lines are displayed if the user single clicks on the folder. I use the same "rules" as for DXL files themselfs; 1st line is a blurb about the folder and the other lines add more info.

The *.idx provides a mechanism to defined the looks of the displayed menu in DOORS. If you fail to insert a DXL file name into the *.idx it is still displayed in DOORS, but you only see its name. Each line in the *.idx has 4 fields separated by tabs or spaces. The first is the name of the DXL file without the ".dxl" ending. The 2nd -3rd fields allow for hot keys to be used to activate the DXL. I've never done that, but if you put "A" in both parts then cntrl-A and alt-A will activate the dxl. Use underscores to mean "no hot keys". The 4th field is the part that appears in the DOORS menu. I always, again, repeat the name of the DXL and give a quick phrase about it.

Example IDX:
DisplayCurrentFolder _ _ DisplayCurrentFolder: Display the currently selected DOORS folder

See DXL manual chapter "The DXL Library and Addins menus" for more confusion.

You won't get it right the first time.

- Louie
Report this to a Moderator Report this to a Moderator
Statistics
20925 users are registered to the Telelogic DOORS forum.
There are currently 0 users logged in.
The most users ever online was 15 on 15-Jan-2009 at 16:36.
There are currently 0 guests browsing this forum, which makes a total of 0 users using this forum.
You have posted 0 messages to this forum. 0 overall.

FuseTalk Standard Edition v3.2 - © 1999-2009 FuseTalk Inc. All rights reserved.