Create Example Flowchart for Workflow Algorithm wiki documents

[Karl Palmen]

Select one workflow algorithm (or group of algorithms) and produce a flowchart for it/them using draw.io save both XML and image file. Link image from wiki page(s) and store the XML in a 'doc/diagrams' folder as sister of the 'include' and 'src' folders.

[Karl Palmen]

draw.io can be accessed through ​https://www.draw.io/ .

[Karl Palmen]

I've found a flowchart for muon workflow atached to ticket #8494. This could be made into an example for MuonLoad.

[Karl Palmen]

Add XML version of flowchart for loadMuon re #9047

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 02a7356a0cbee542edb89b1c4544df6f06c261ec

[Karl Palmen]

Modify MuonLoad wiki to use flowchart re #9047

Also move XML for flowchart to WorkflowAlgorithms.

Changeset: 9d892df7bfa7bbfb7684356939dfe9b79b5c6534

[Karl Palmen]

To test check that the wiki for MuonLoad has been improved adequately with flow chart.

Look for MuonWorkflow.xml in WorkflowAlgorithms/doc/diagrams .

Go to ​https://www.draw.io and select "Device". Then select "Open existing diagram ..." and load the MuonWorkflow.xml file. You should then see a flowchart. Verify that it is a copy of the flowchart in the wiki.

[Karl Palmen]

Also verify that the wiki was made by wikimaker.

[Karl Palmen]

It is possible before testing that wikimaker has undone the changes. If so, find older version with the change in it.

[Karl Palmen]

Workflow in flowchart is now out of date.

[Karl Palmen]

Update flowchart MuonWorkflow re #9047

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d8d87595c3638595f60057138219acf49dc671a1

[Nick Draper]

Spelling error in png file in the wiki http://www.mantidproject.org/images/a/a0/MuonWorkflow.png

Loaded Wprkspace -> Loaded Workspace

Also other items as discussed.

1. use colour consistently
2. Parameter names need to match those of the algorithm
3. Drop the workspace icons in the diagram and just label the arrows
4. Decisions need a label in the form of a question
5. Only mention algorithms used within the workflow alg itself - do not go deeper within algs used within this alg (Example here is LoadNexusProcessed)
6. Use the Cylinder (database) for the final output workspace

[Karl Palmen]

Improve Flowchart and correct description of SecondPeriod re #9047

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d31f57a07be9eeb0da703a86b6b9ba145e6ce136

[Karl Palmen]

I'm looking into default handling.

[Karl Palmen]

Modify the display of default handling in flowchart re #9047

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 38e22f1aecf585efd38f3b9f3afc6f4220a8fd03

[Nick Draper]

Merge remote-tracking branch 'origin/feature/9047_example_flowchart_wiki'

Full changeset: ​7970a77d5770a78b651a0a330adcf915c7bc752e

[Stuart Campbell]

This ticket has been transferred to github issue ​9890