Skip to content

Commit 698e9de

Browse files
committed
Cleanup naming to be uniformized
1 parent d2c4117 commit 698e9de

File tree

113 files changed

+141
-121
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+141
-121
lines changed

docs/01_User_Manual/10-Official_Videos/_category_.json

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/01_User_Manual/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/02_Developer_Documentation/Code-Style.md renamed to docs/Developer_Documentation/Code_Style.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: code-style
2+
id: code_style
33
title: Code Style
4+
sidebar_position: 3
45
tags:
56
- Code Style
67
- Development

docs/02_Developer_Documentation/Developer-Handbook.md renamed to docs/Developer_Documentation/Developer_Handbook.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: developer-handbook
2+
id: developer_handbook
33
title: Developer Handbook
4+
sidebar_position: 1
45
---
56

67
This page explains how to contribute to Gephi's development.

docs/02_Developer_Documentation/How-to-build-Gephi.md renamed to docs/Developer_Documentation/How_to_build_Gephi.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: how-to-build-gephi
2+
id: how_to_build_gephi
33
title: How to build Gephi
4+
sidebar_position: 2
45
---
56

67
Follow this guide to start developing the Gephi source code and test your changes.
@@ -20,7 +21,7 @@ Gephi software architecture is modular and therefore each feature is split into
2021

2122
* [Gephi APIs documentation](http://gephi.org/docs/api)
2223

23-
![image](/docs/02_Developer_Documentation/How-to-build-Gephi/00_image.png)
24+
![image](/docs/Developer_Documentation/How-to-build-Gephi/00_image.png)
2425

2526
## Build Gephi
2627

@@ -70,19 +71,19 @@ Once built, Gephi can be run from the `modules/application` folder using a speci
7071

7172
Open Netbeans and go to **File > Open Project** to look for the Gephi folder. Then, **Open Project**. Ensure the checkbox "Open Required Projects" is not selected.
7273

73-
![Opening Gephi](/docs/02_Developer_Documentation/How-to-build-Gephi/01_Opening Gephi.png)
74+
![Opening Gephi](/docs/Developer_Documentation/How-to-build-Gephi/01_Opening Gephi.png)
7475

7576
Right-click on the project and select **Clean and Build**.
7677

77-
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/02_Build.png)
78+
![Build](/docs/Developer_Documentation/How-to-build-Gephi/02_Build.png)
7879

7980
Next, in the **Projects** tab of the file navigator, select **Gephi > Modules > gephi-app** and open the application module.
8081

81-
![Open gephi-app](/docs/02_Developer_Documentation/How-to-build-Gephi/03_Open gephi-app.png)
82+
![Open gephi-app](/docs/Developer_Documentation/How-to-build-Gephi/03_Open gephi-app.png)
8283

8384
Finally, select **Run** from this module.
8485

85-
![Run](/docs/02_Developer_Documentation/How-to-build-Gephi/04_Run.png)
86+
![Run](/docs/Developer_Documentation/How-to-build-Gephi/04_Run.png)
8687

8788
### Troubleshooting
8889

@@ -96,37 +97,37 @@ As Gephi is a Maven project it is well supported by IntelliJ but requires some t
9697

9798
Open IntelliJ and open the Gephi folder. You'll be asked whether you want to Trust this Maven repository. Select **Trust Project**.
9899

99-
![Trust Maven](/docs/02_Developer_Documentation/How-to-build-Gephi/05_Trust Maven.png)
100+
![Trust Maven](/docs/Developer_Documentation/How-to-build-Gephi/05_Trust Maven.png)
100101

101102
IntelliJ then takes some time to scan the project and resolve dependencies. Once completed, you should see Gephi properly listed as a project in the Project pane.
102103

103-
![Project loaded](/docs/02_Developer_Documentation/How-to-build-Gephi/06_Project loaded.png)
104+
![Project loaded](/docs/Developer_Documentation/How-to-build-Gephi/06_Project loaded.png)
104105

105106
Then, navigate to IntelliJ's preferences panel **Build, Execution, Deployment > Build Tools > Maven > Runner** and select the option **Delegate IDE build/run actions to Maven**. This is a critical step.
106107

107-
![Maven delegate config](/docs/02_Developer_Documentation/How-to-build-Gephi/07_Maven delegate config.png)
108+
![Maven delegate config](/docs/Developer_Documentation/How-to-build-Gephi/07_Maven delegate config.png)
108109

109110
Next in the top-level menu select **Build > Build Project**.
110111

111112
If it fails with and error like `javac flag not found --release`, you would need to fo back to **Build, Execution, Deployment > Build Tools > Maven > Runner** and add an **Environment Variables** with `JAVA_HOME=<path of the selected JDK>`
112113

113-
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/08_Build.png)
114+
![Build](/docs/Developer_Documentation/How-to-build-Gephi/08_Build.png)
114115

115116
Once completed, create a run configuration by following **Run > Edit Configurations...** in the top-level menu.
116117

117-
![Build](/docs/02_Developer_Documentation/How-to-build-Gephi/09_Build.png)
118+
![Build](/docs/Developer_Documentation/How-to-build-Gephi/09_Build.png)
118119

119120
Here, select **Add new configuration** and search for **Maven**.
120121

121-
![Add Maven Config](/docs/02_Developer_Documentation/How-to-build-Gephi/10_Add Maven Config.png)
122+
![Add Maven Config](/docs/Developer_Documentation/How-to-build-Gephi/10_Add Maven Config.png)
122123

123124
Next, we'll configure two things here. Enter `nbm:cluster-app nbm:run-platform` into the **Command line** field and select the `modules/application` sub-directory into the **Working directory** chooser. Give Gephi as name for the configuration.
124125

125-
![Set Maven Config](/docs/02_Developer_Documentation/How-to-build-Gephi/11_Set Maven Config.png)
126+
![Set Maven Config](/docs/Developer_Documentation/How-to-build-Gephi/11_Set Maven Config.png)
126127

127128
Finally, you can run Gephi by selecting **Run > Run 'Gephi'** from the top-level menu.
128129

129-
![Run](/docs/02_Developer_Documentation/How-to-build-Gephi/12_Run.png)
130+
![Run](/docs/Developer_Documentation/How-to-build-Gephi/12_Run.png)
130131

131132
### Troubleshooting
132133

docs/02_Developer_Documentation/Localization.md renamed to docs/Developer_Documentation/Localization.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: localization
33
title: Localization
4+
sidebar_position: 5
45
---
56

67
Gephi has a localization program to provide the software in your language: this page describes how to contribute! We use the [Weblate](https://hosted.weblate.org/projects/gephi/).
File renamed without changes.
Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
id: add-a-module-panel
2+
id: Add_a_module_panel
33
title: Add a module panel
4+
sidebar_position: 12
45
---
56

67
How to create a panel for plugin features, similar to Ranking, Graph or Layout? It is easy and fully integrated in Netbeans. Create your panel class and use Netbeans IDE to design the user interface. This page also explains how to work with the **Perspective** system.
78

8-
![800px-add-module-panel](/docs/04_Plugins/Add-a-module-panel/00_800px-add-module-panel.png)
9+
![800px-add-module-panel](/docs/Plugins/Add_a_module_panel/00_800px-add-module-panel.png)
910

1011

1112
- **Step 1**: Right click on your module and select **New > Other...** and find **Window** like showed in the step 1 below. The window wizard asks where to put your panel. You can use already defined modes (i.e. positions):
@@ -16,19 +17,19 @@ How to create a panel for plugin features, similar to Ranking, Graph or Layout?
1617
* filtersmode: Bottom Right
1718
* contextmode: Top Right
1819

19-
![add-module-panel1](/docs/04_Plugins/Add-a-module-panel/01_add-module-panel1.png)
20+
![add-module-panel1](/docs/Plugins/Add_a_module_panel/01_add-module-panel1.png)
2021

2122
- **Step 2**: Then check options about the panel policy showed in step2 and click on **Next**.
2223

23-
![add-module-panel2](/docs/04_Plugins/Add-a-module-panel/02_add-module-panel2.png)
24+
![add-module-panel2](/docs/Plugins/Add_a_module_panel/02_add-module-panel2.png)
2425

2526
- **Step 3**: Fill the **Class Name**, the system shows which files are created. Your panel is a **TopComponent** subclass.
2627

27-
![add-module-panel3](/docs/04_Plugins/Add-a-module-panel/03_add-module-panel3.png)
28+
![add-module-panel3](/docs/Plugins/Add_a_module_panel/03_add-module-panel3.png)
2829

2930
- **Step 4**: Click on **Finish**, files are created and you're invited to design your panel with Netbeans editor.
3031

31-
![add-module-panel-design](/docs/04_Plugins/Add-a-module-panel/04_add-module-panel-design.png)
32+
![add-module-panel-design](/docs/Plugins/Add_a_module_panel/04_add-module-panel-design.png)
3233

3334
Your panel is now created and automatically registered. Start Gephi with your plugin and your panel is visible.
3435

@@ -38,7 +39,7 @@ Your panel is now created and automatically registered. Start Gephi with your pl
3839

3940
1. Add **Desktop Perspective** as a new module dependency. Right-click on your module and Properties.
4041
2. Go to your `TopComponent` sources and add `PerspectiveMember` as interface.
41-
3. Add the `@ServiceProvider` annotation to be registered by the system and implement methods (note: you will need to add the 'Desktop Perspective' to the Module Dependencies [screenshots](http://activeintelligence.org/blog/archive/gephi-howto-add-a-module-panel-dependency/)).
42+
3. Add the `@ServiceProvider` annotation to be registered by the system and implement methods (note: you will need to add the 'Desktop Perspective' to the Module Dependencies [screenshots](http://activeintelligence.org/blog/archive/gephi-howto-Add_a_module_panel-dependency/)).
4243

4344
```java
4445
@ServiceProvider(service=PerspectiveMember.class)
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
2-
id: add-a-submenu
2+
id: Add_a_submenu
33
title: Add a submenu
4+
sidebar_position: 13
45
---
56

67
From a plugin it is easy to add a menu in the menubar, for instance in **Plugins**. If you wanna add your action in a already existing menu, like **Generate**, don't follow this HowTo but look more how to create a new Generator, as the submenus may be created dynamically.
@@ -9,20 +10,20 @@ From a plugin it is easy to add a menu in the menubar, for instance in **Plugins
910

1011
- **Step 1**: Right click on your module and select **New > Other...** and find **Action** like showed in the step 1 below. The action wizard will create everything necessary to register your action in the system and create the submenu.
1112

12-
![addsubmenu-new-action](/docs/04_Plugins/Add-a-submenu/00_addsubmenu-new-action.png)
13+
![addsubmenu-new-action](/docs/Plugins/Add_a_submenu/00_addsubmenu-new-action.png)
1314

1415
- **Step 2**: Then click on **Next**, be sure **Always Enabled** is checked and **Next** again.
1516
- **Step 3**: In the **Menu** option, select where you want your submenu to be put. Select **Plugins** to be put in this menu.
1617

17-
![addsubmenu-new-action-gui](/docs/04_Plugins/Add-a-submenu/01_addsubmenu-new-action-gui.png)
18+
![addsubmenu-new-action-gui](/docs/Plugins/Add_a_submenu/01_addsubmenu-new-action-gui.png)
1819

1920
- **Step 4**: Click on **Next** and fill the class name, as well as the display name.
2021

21-
![addsubmenu-new-action-name](/docs/04_Plugins/Add-a-submenu/02_addsubmenu-new-action-name.png)
22+
![addsubmenu-new-action-name](/docs/Plugins/Add_a_submenu/02_addsubmenu-new-action-name.png)
2223

2324
- **Step 5**: Finally, click on **Next** to create the file.
2425

25-
![addsubmenu-new-action-result](/docs/04_Plugins/Add-a-submenu/03_addsubmenu-new-action-result.png)
26+
![addsubmenu-new-action-result](/docs/Plugins/Add_a_submenu/03_addsubmenu-new-action-result.png)
2627

2728
*Result*
2829

0 commit comments

Comments
 (0)