Workflow in-application docs

I stumbled on this issue with the workflow editor:

http://youtrack.jetbrains.com/issue/JT-14552

What caught my attention there was the screen shot, which shows documentation for the format() method:

http://youtrack.jetbrains.com/_persistent/screenshot1.png?file=74-76564&v=1&c=true&rw=953&rh=796

Since I've been using the editor the last couple of days, I've never seen docs like that, and I've not been able to get them to show for the format() method. This is what I see in the inspector instead:

Screen Shot 2013-02-21 at 17.37.03.png


How do I get the extended docs, which I assume extend (sorry, no pun intended) to many (all?) other methods? Is there something I need to install? I poked through the prefs but didn't see anything. The lack of detailed docs has been a definite sore spot for me, and this looks to be a great help.

Thanks.
8 comments
Comment actions Permalink
Hello Bob,

Your use-case is pretty clear.

You can look at the full reference of Workflow editor (and also about existed default workflows) here http://confluence.jetbrains.com/display/YTD4/Workflow+Guide . Also, you can find there information about our Workflow GitHub repository, where you can find the reference according to each workflow and its actions.

If you have any questions, we'll be happy to assist you with creating your own workflow.
0
Comment actions Permalink
I've read and have been using the docs you linked to. However, what I was referring to was actually the context-sensitive help showing in the workflow editor itself, right in the inspector window. The screen shot I linked to from JT-14552 has detailed information that simply isn't present in the web docs that you linked to - information that would be extremely helpful. I'm wondering how I get my copy of the workflow editor to show those context-senstive docs.
0
Comment actions Permalink
Hello Bob,


Unfortunatelly, we haven't got these hints in documents.
As "Workflow editor" is customised MPS IDE, such details are available in MPS blog http://blogs.jetbrains.com/mps/ . "Workflow editor" is very young and experimantal tool, thus we are happy when our users notice what materials and documents will be helpfull except existed.
I've created a task based on your request http://youtrack.jetbrains.com/issue/JT-18794 , you are welcome to vote and leave comments.
Thank you for your interest!

Yes, we have our evangelists, that often posts their manuals and topics to YouTrack blogs and to private. Here is one of them, Hadi Hariri. Here is the prvate blog with the deeper YouTrack hints and patterns and worflow hints http://hadihariri.com/ and here is our blog http://blog.jetbrains.com/youtrack/ .

If it doesn't help, please provide us with your exactly scenario and we'll be happy to assist you.
0
Comment actions Permalink
The blogs are great resources, but I'm still confused about the docs I referenced. Please review this task:

http://youtrack.jetbrains.com/issue/JT-14552#

It's asking for more formatting options to display dates from workflows. A JetBrains user, yamaxim, is assigned the task and adds a comment saying that the additional options were added and released in version 4.0. Yamaxim also attaches the screen shot I referenced and specifically says, "Format details can be found in an Inspector for the format expression." And indeed, that's exactly what the screen shot shows. So, from that task, it seems pretty definitive that the feature already exists. Is that not the case? If not, then what's the screen shot?
0
Comment actions Permalink
Bob,

As I've said earlier, unfortunately, we haven't got the Inspector reference now.
I have created this task http://youtrack.jetbrains.com/issue/JT-18794 , it's for adding detailed Inspector manual in our documentation.
You request is clear, and that's why I ask you about your workflow scenario. We can assist you with it while Inspector reference has not created.
Also, there are a lot of helpful hints in blogs, that I've added in previos message.

Soon, I'll add Inspector hot-keys here for you, while more detailed guide has not completed.

Thank you.
0
Comment actions Permalink
Okay, I figured it out. Turns out, if you type a hash symbol to start the parameter list for the format method, the docs pop right up in the Inspector pane exactly as shown in the linked task. Very cool.

Now I'm wondering what other Inspector-based docs are waiting to be discovered :-).
0
Comment actions Permalink
Hello Bob,

Please check the Inspector reference http://confluence.jetbrains.com/display/YTD4/Using+Inspector+in+Workflow+Editor
and contact us if it doesn't help.
I should say that there are only 3 constructions that are documented in Inspector.
If you need more comments, provide us with your cases and we'll help.

Thank you.
0

Please sign in to leave a comment.