topic Re: Custom Macro Parameter Descriptions - How to Format Description? in SAS Enterprise Guide

Custom Macro Parameter Descriptions - How to Format Description?

data_snawb — Fri, 04 Oct 2019 13:38:11 GMT

I am playing around with delivering a suite of macros to some of my customers and while I have external documentation on them, I would like to provide built in descriptions within EG. An example of this would be when you type the keyword "data" and mouse over it, you get the description tool tip that pops up. In the example of mousing over the "data" keyword text has bold formatting as well as carriage returns. When writing your own macro, you have the ability to customize and create this description by inserting a comment after a parameter. This can be done for multiple parameters.

My question is how do I format this description? I've tried many common escape sequences trying to get this to happen to no avail. What I'd like to see is the ability to have the description have line breaks so I can provide something like

Description:

Syntax:

Examples:

Instead what I get it all of that run together: "Description: Syntax: Examples: 1) 2)"

Code Example:

%macro foo(bar /* Description:
                  Syntax:
                  Examples:
                      1)
                      2)
                */);

    /* code to execute here */
%mend foo;

%foo(value);

Tool tip built in stating can be customized.

Tool tip with customization:

Edit: added Screenshots

Re: Custom Macro Parameter Descriptions - How to Format Description?

Tom — Thu, 03 Oct 2019 20:58:41 GMT

Does EG have the SNIPPETS concept that is in SAS/Studio?

Perhaps you can make something like that rather than pop-up text.

Re: Custom Macro Parameter Descriptions - How to Format Description?

Reeza — Thu, 03 Oct 2019 21:06:08 GMT

Consider custom tasks in EG?
https://communities.sas.com/t5/Ask-the-Expert/Creating-custom-tasks-for-SAS-Enterprise-Guide/ta-p/395172

Re: Custom Macro Parameter Descriptions - How to Format Description?

data_snawb — Fri, 04 Oct 2019 13:39:23 GMT

Thank you for your response. Unfortunately, snippets is not what I'm looking for in this case. EG does in fact have snippet functionality though. I'm looking at modifying the context within the tool tip that pops up explaining what the keyword is. I have added screenshots to the original post for clarification.

Re: Custom Macro Parameter Descriptions - How to Format Description?

data_snawb — Fri, 04 Oct 2019 13:41:21 GMT

Thank you for your response. Ideally they would like to avoid custom tasks in EG as ultimately everything will be submitted for batch so the EGP is not being used in production.

Re: Custom Macro Parameter Descriptions - How to Format Description?

Tom — Fri, 04 Oct 2019 14:34:48 GMT

This is how I format macro header. I don't use EG, can you see if that style works with its "tooltip" feature?

%macro xxx
/*----------------------------------------------------------------------
Short description
----------------------------------------------------------------------*/
(p1=P1     /* Parameter one description */
,p1=P1     /* Parameter two description */
);

/*----------------------------------------------------------------------
Usage:

one or more usage examples
------------------------------------------------------------------------
Notes:

additional information
-----------------------------------------------------------------------
History:

yyyy-mm-dd username Creation
----------------------------------------------------------------------*/

Re: Custom Macro Parameter Descriptions - How to Format Description?

data_snawb — Fri, 04 Oct 2019 15:44:05 GMT

Thank you for your response. This is looking like the route we're going to have to go. The idea was for them to not have to look at the macro/header in another file or any external documentation. I may add a macro parameter for help. If it's used then it returns the help information to their log like when using commands on a terminal/command line with a help switch. In the long run once they're comfortable with the macro the need to refer to documentation drops drastically. This would also work with any other client and not just EG specific.

I would still be curious to know if anyone finds out this EG tool tip formatting thing just because I enjoy knowing how things work.