/doc/examples/colour_schemes/flowchart_colours.rst

https://code.google.com/p/ruffus/ · ReStructuredText · 48 lines · 32 code · 16 blank · 0 comment · 0 complexity · e1342407092361b712db1215497f13f9 MD5 · raw file 

    

  1. .. include:: ../../global.inc
    2. 

  2. 

  3. .. _flowchart_colours:
    4. 

  4. 

  5. ******************
    6. 

  6. Flowchart colours
    7. 

  7. ******************
    8. 

  8. 

  9. * See :ref:`code <flowchart_colours.code>` for experimenting with colours 
    10. 

  10. 

  11. The appearance of Ruffus flowcharts produced by :ref:`pipeline_printout_graph <pipeline_functions.pipeline_printout_graph>` 
    12. 

  12. can be extensively customised.
    13. 

  13. 

  14. This is mainly controlled by the :ref:`user_colour_scheme <pipeline_functions.pipeline_printout_graph.user_colour_scheme>`  (note UK spelling of "colour") parameter 
    15. 

  15. 

  16. Example:
    17. 

  17. 

  18.     Use colour scheme index  = 1
    19. 

  19.     ::
    20. 

  20. 

  21.         pipeline_printout_graph ("flowchart.svg", "svg", [final_task],
    22. 

  22.                                  user_colour_scheme = {
    23. 

  23.                                                         "colour_scheme_index" :1,
    24. 

  24.                                                         "Pipeline"      :{"fontcolor" : '"#FF3232"' },
    25. 

  25.                                                         "Key"           :{"fontcolor" : "Red",      
    26. 

  26.                                                                           "fillcolor" : '"#F6F4F4"' },
    27. 

  27.                                                         "Task to run"   :{"linecolor" : '"#0044A0"' },
    28. 

  28.                                                         "Final target"  :{"fillcolor" : '"#EFA03B"',
    29. 

  29.                                                                           "fontcolor" : "black",    
    30. 

  30.                                                                           "dashed"    : 0           }
    31. 

  31.                                                        })
    32. 

  32. 

  33. 

  34. There are 8 colour schemes by setting ``"colour_scheme_index"``:
    35. 

  35.     ::
    36. 

  36. 

  37.         pipeline_printout_graph ("flowchart.svg", "svg", [final_task],
    38. 

  38.                                   user_colour_scheme = {"colour_scheme_index" :6})
    39. 

  39. 

  40. 

  41. These colours were chosen after much fierce arguments between the authors and friends, and much
    42. 

  42. inspiration from  http://kuler.adobe.com/#create/fromacolor. Please
    43. 

  43. feel free to submit any additional sets of colours for our consideration.
    44. 

  44. 

  45. 

  46. (Click here for image in :download:`svg <../../images/flowchart_colour_schemes.svg>`.)
    47. 

  47. 

  48. .. image:: ../../images/flowchart_colour_schemes.png
    49.