Changes for page Diagram Application (Pro)

Last modified by Administrator on 2024/04/12 00:01
<
From version < 435.1 >
edited by Silvia Macovei
on 2019/08/26 16:39
To version < 436.1 >
edited by Silvia Macovei
on 2019/08/26 16:47
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,62 +1,15 @@
1 1  {{extensionToc/}}
2 2  
3 -This is a simple application that integrates ##jgraph/draw.io## in XWiki, adding support for editing and viewing diagrams. Each diagram is stored in a wiki page. It doesn't require any external services in order to work properly.
3 +With this application you can edit and view diagrams in XWiki, using the jgraph/draw.io integration.
4 4  
5 -== Creating a new diagram ==
5 +You can create a big array of diagrams, such as: wireframes, mockups, UML, charts, BPMN, mind maps, tree & network diagrams etc.
6 6  
7 -To create a new diagram click on ##Diagrams## in the Applications panel.
7 +Each diagram is stored in a wiki page. The revisions of the diagrams are synched in XWiki.
8 8  
9 -{{image reference="DiagramPanel.png" width="200"/}}
9 +The app provides intuitive functionalities for both beginners and advanced users. You can:
10 +* add and edit new diagrams
11 +* import existing diagrams
12 +* export diagrams as PDF and images
13 +* view the diagrams as images attached to wiki pages
14 +* include diagrams in other wiki pages
10 10  
11 -Click on the ##Create## button, fill in the diagram name and select the ##Diagram## template, then click ##Create## again.
12 -
13 -{{image reference="DiagramsHome.png" width="920"/}}
14 -
15 -{{image reference="CreateDiagram.png" width="920"/}}
16 -
17 -Use the editor to create your diagram, then click ##Save & View##.
18 -
19 -{{image reference="DiagramEdit.png" width="920"/}}
20 -
21 -{{image reference="DiagramView.png" width="920"/}}
22 -
23 -== Including a diagram in another wiki page ==
24 -
25 -=== Using the WYSIWYG editor ===
26 -
27 -If you wish to display an existing diagram on another page you should use the Diagram Macro. Go to the wiki page where you'd like to include the diagram. In edit mode, click on the ##XWiki Macro## icon.
28 -
29 -{{image reference="DiagramMacro.png" width="670"/}}
30 -
31 -Select the Diagram Macro from the list of macros.
32 -
33 -{{image reference="AddDiagramMacro.png" width="620"/}}
34 -
35 -Fill in the path to the diagram you wish to include and click ##Submit##.
36 -
37 -{{image reference="EditDiagramMacro.png" width="620"/}}
38 -
39 -You will be able to see the included diagram both in edit mode and in view mode.
40 -
41 -{{image reference="DiagramMacroEditMode" width="670"/}}
42 -//Included diagram in edit mode.//
43 -
44 -{{image reference="DiagramMacroViewMode" width="920"/}}
45 -//Included diagram in view mode.//
46 -
47 -=== Using the Wiki editor ===
48 -
49 -If you're more inclined to write code directly, you can write the following directly in wiki mode:
50 -
51 -{{code language="none"}}
52 -{{diagram reference="Path.To.DiagramPage" cached="true" /}}
53 -{{/code}}
54 -
55 -== A few diagram examples ==
56 -
57 -{{gallery}}
58 -image:editDiagram.png
59 -image:editDiagramFullScreen.png
60 -image:viewDiagram.png
61 -image:viewDiagramMacro.png
62 -{{/gallery}}
Store.Code.PayingAppsClass[0]
Documentation
... ... @@ -1,1 +1,59 @@
1 -
1 +
2 +== Creating a new diagram ==
3 +
4 +To create a new diagram click on ##Diagrams## in the Applications panel.
5 +
6 +{{image reference="DiagramPanel.png" width="200"/}}
7 +
8 +Click on the ##Create## button, fill in the diagram name and select the ##Diagram## template, then click ##Create## again.
9 +
10 +{{image reference="DiagramsHome.png" width="920"/}}
11 +
12 +{{image reference="CreateDiagram.png" width="920"/}}
13 +
14 +Use the editor to create your diagram, then click ##Save & View##.
15 +
16 +{{image reference="DiagramEdit.png" width="920"/}}
17 +
18 +{{image reference="DiagramView.png" width="920"/}}
19 +
20 +== Including a diagram in another wiki page ==
21 +
22 +=== Using the WYSIWYG editor ===
23 +
24 +If you wish to display an existing diagram on another page you should use the Diagram Macro. Go to the wiki page where you'd like to include the diagram. In edit mode, click on the ##XWiki Macro## icon.
25 +
26 +{{image reference="DiagramMacro.png" width="670"/}}
27 +
28 +Select the Diagram Macro from the list of macros.
29 +
30 +{{image reference="AddDiagramMacro.png" width="620"/}}
31 +
32 +Fill in the path to the diagram you wish to include and click ##Submit##.
33 +
34 +{{image reference="EditDiagramMacro.png" width="620"/}}
35 +
36 +You will be able to see the included diagram both in edit mode and in view mode.
37 +
38 +{{image reference="DiagramMacroEditMode" width="670"/}}
39 +//Included diagram in edit mode.//
40 +
41 +{{image reference="DiagramMacroViewMode" width="920"/}}
42 +//Included diagram in view mode.//
43 +
44 +=== Using the Wiki editor ===
45 +
46 +If you're more inclined to write code directly, you can write the following directly in wiki mode:
47 +
48 +{{code language="none"}}
49 +{{diagram reference="Path.To.DiagramPage" cached="true" /}}
50 +{{/code}}
51 +
52 +== A few diagram examples ==
53 +
54 +{{gallery}}
55 +image:editDiagram.png
56 +image:editDiagramFullScreen.png
57 +image:viewDiagram.png
58 +image:viewDiagramMacro.png
59 +{{/gallery}}
XWiki SAS Copyright © 2024