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 < 438.1 >
edited by Silvia Macovei
on 2019/08/26 16:49
>
Change comment: There is no comment for this version

Summary

Details

ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,57 +1,21 @@
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 10  
11 -Click on the ##Create## button, fill in the diagram name and select the ##Diagram## template, then click ##Create## again.
11 +* add and edit new diagrams
12 +* import existing diagrams
13 +* export diagrams as PDF and images
14 +* view the diagrams as images attached to wiki pages
15 +* include diagrams in other wiki pages
12 12  
13 -{{image reference="DiagramsHome.png" width="920"/}}
17 +To learn more about how to create, edit and include diagrams please visit the [[documentation tab>>https://store.xwiki.com/xwiki/bin/view/Extension/DiagramApplication#documentation]]
14 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 55  == A few diagram examples ==
56 56  
57 57  {{gallery}}
... ... @@ -60,3 +60,4 @@
60 60  image:viewDiagram.png
61 61  image:viewDiagramMacro.png
62 62  {{/gallery}}
27 +
Store.Code.PayingAppsClass[0]
Documentation
... ... @@ -1,1 +1,49 @@
1 -
1 +== Creating a new diagram ==
2 +
3 +To create a new diagram click on ##Diagrams## in the Applications panel.
4 +
5 +{{image reference="DiagramPanel.png" width="200"/}}
6 +
7 +Click on the ##Create## button, fill in the diagram name and select the ##Diagram## template, then click ##Create## again.
8 +
9 +{{image reference="DiagramsHome.png" width="920"/}}
10 +
11 +{{image reference="CreateDiagram.png" width="920"/}}
12 +
13 +Use the editor to create your diagram, then click ##Save & View##.
14 +
15 +{{image reference="DiagramEdit.png" width="920"/}}
16 +
17 +{{image reference="DiagramView.png" width="920"/}}
18 +
19 +== Including a diagram in another wiki page ==
20 +
21 +=== Using the WYSIWYG editor ===
22 +
23 +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.
24 +
25 +{{image reference="DiagramMacro.png" width="670"/}}
26 +
27 +Select the Diagram Macro from the list of macros.
28 +
29 +{{image reference="AddDiagramMacro.png" width="620"/}}
30 +
31 +Fill in the path to the diagram you wish to include and click ##Submit##.
32 +
33 +{{image reference="EditDiagramMacro.png" width="620"/}}
34 +
35 +You will be able to see the included diagram both in edit mode and in view mode.
36 +
37 +{{image reference="DiagramMacroEditMode" width="670"/}}
38 +//Included diagram in edit mode.//
39 +
40 +{{image reference="DiagramMacroViewMode" width="920"/}}
41 +//Included diagram in view mode.//
42 +
43 +=== Using the Wiki editor ===
44 +
45 +If you're more inclined to write code directly, you can write the following directly in wiki mode:
46 +
47 +{{code language="none"}}
48 +{{diagram reference="Path.To.DiagramPage" cached="true" /}}
49 +{{/code}}
XWiki SAS Copyright © 2024