FDK documentation links (Subj was "April 11th Webinar: FrameMaker 11...."

Fri Apr 12 10:15:58 PDT 2013

Hello Russ,

I am very glad that you figured out a solution. You do not need to apologize for "whining"; it was good constructive criticism, and our team welcomes that. I should have made it clear in my response that I did recognize and appreciate your difficult situation. -- I will certainly pass your insights and solutions listed below onto our development team. 

FYI -- for the whole group, here is a way to ensure that your message is crystal clear regarding documentation enhancements:

== make a PDF file that contains only the relevant pages from FDK or other documentation
== use annotations in PDF to identify the incomplete text and add either your request for more specific information, or something new that you found works
== if you discover a capability that is not documented, but you think should be, please use the same "short PDF" annotation solution.
== email the PDF attachment with a brief request or explanation to me at: mhoffman at adobe.com (one "n"). -- ask for a REPLY so I can acknowledge, and you'll know that the message got through.

Thanks everyone, for helping us identify areas where the product and/or documentation can be improved.

__________________________________
Maxwell Hoffmann |  Product  Evangelist  |  Adobe  |  p. 503.336.5952  |  c. 503.805.3719  |  mhoffman at adobe.com 
http://twitter.com/maxwellhoffmann -  http://www.linkedin.com/in/maxwellhoffmann  blogs.adobe.com/techcomm
Upcoming webinars http://adobe.ly/Pbz6xI    Recorded webinars: http://adobe.ly/Pbdp0J

-----Original Message-----
From: framers-bounces at lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of russ at weststreetconsulting.com
Sent: Wednesday, April 10, 2013 10:34 AM
To: framers at lists.frameusers.com
Subject: RE: FDK documentation links (Subj was "April 11th Webinar: FrameMaker 11...."

Hi Maxwell,

Thank you for taking the time to respond. I do have these documents and unfortunately the content is insufficient. However... before I whined one last time, I did some more experimentation and I think I finally figured it out. If it is of any interest to your technical publications team, I've put a summary of the problem and my recommendations below.
Again, thanks for your time.

Russ

RE: Adding a custom dialog box to a workspace

It took me a long time to figure this out because I think that the FDK documentation is missing some details. Here is what it says now:

"Because FrameMaker provides support for workspaces, the client's modeless dialogs can become a part of a workspace. To make this work, the client has to handle the notification FA_Note_Dialog_Create, which is sent to the client when the workspace has to launch the modeless dialog for a particular client."

I guess the answer is in there, but there was not enough clarification for me to figure it out initially. I finally figured out that when you save a workspace with the dialog open, the notification then happens automatically once you select or reset that workspace in the future.
Also, there is the fact that "sparm" is set to the name of the dialog, which you need to test in order to know how to respond. So, I would recommend adding some verbiage similar to the following:

When a workspace is saved with a custom modeless dialog open, the name and positioning of that dialog are stored with the workspace. Then, when the user selects or resets the workspace, FrameMaker sends the FA_Note_Dialog_Create to the respective client with sparm set to the name of the dialog box. It is then the responsibility of the client to handle this notification and execute the required code to open the dialog box again. Once the dialog box is open and the client code exits, the workspace configuration routine will continue and automatically position the dialog box as stored in the workspace.

Note the following:

- FA_Note_Dialog_Create is only sent when the workspace includes a custom dialog that was open when the workspace was saved. If multiple custom dialogs were open, individual notifications are sent for each.

- The client notification code must reopen the dialog itself (F_ApiOpenResource(), etc.), then the workspace will position it.

- Like all notifications, FA_Note_Dialog_Create must be enabled with F_ApiNotification().

>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

Message: 17
Date: Tue, 9 Apr 2013 16:19:27 -0700
From: Maxwell Hoffmann <mhoffman at adobe.com>
To: "russ at weststreetconsulting.com" <russ at weststreetconsulting.com>
Cc: "framers at lists.frameusers.com" 
Subject: FDK documentation links (Subj was "April 11th Webinar:  FrameMaker 11...."

Russ,

Thank you for your inquiry and the reminder. I consulted internal resources and URL links to current FDK documentation are listed below.
Note: some of the URLs below may have line breaks and require post e-mail format editing.

FDK Installer File:
http://download.macromedia.com/pub/developer/framemaker/FDK11_0380_4_Setup.zip

FDK 11.0 Documentation :
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/framemaker/pdfs/fdkinstallguide.pdf
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/framemaker/pdfs/fdkprogrammerguide.pdf
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/framemaker/pdfs/fdkreference.pdf

The page with all these links:
http://www.adobe.com/devnet/framemaker.html

I hope that these links contain what you are seeking. If you need more information, please let me know.

_____________________________
Maxwell Hoffmann | Product Evangelist | Adobe | p. 503.336.5952 | c.
503.805.3719 | mhoffman at adobe.com<mailto:mhoffman at adobe.com>
http://twitter.com/maxwellhoffmann -
http://www.linkedin.com/in/maxwellhoffmann 
[snip]