Help:Layout Documentation
From Gephi:Wiki
In this article you can find help on how to describe a layout in our documentation. There are templates and guidelines which are documented in this Wiki article.
A complete example of a layout can be found here.
Contents |
Creating the Layout Page
At first you have to create a page with the name of the layout, for example ForceAtlas.
Layouts do not belong to a special namespace.
- If the layout exists in Gephi, the name should be similar to the used name in the software. Please note, if you find a layout which is not documented yet, well done. Please, even you have only less time, just create the page with the name of the layout. We will help you complete the description.
- If the layout does not exist, you are free to choose a name of your own.
Creating the Layout Headlines
At the moment there are four headlines important for a layout.
- Objective: Contains a short description of the layout.
- Explanation (optional): Describes the layout and the idea behind it more deeply. It would be even great to have an example of how this layout can be used and how it should be interpreted.
- Reference: Contains all weblinks and literature used to describe a layout. Please consider our bibliography.
- Additional Reading: Further documents which discuss this layout.
Default Usage:
==Objective== ==Explanation== ==Reference== ==Additional Reading==
Categorization of layout pages
Please add one category to each measure page. This is the the category Category:Layout
Sub-categories are:
Creating special content
For general help see Help:Editing.
| What it looks like | What you type | |||
|---|---|---|---|---|
|
For the Layout Headlines please use the normal section wiki markup (==). Layout Headline |
== Layout Headline == |
|||
|
For the mathematical representation of the layout please use the varieties of <math>. For more help on displaying a formula take a look here. |
<math>A_c = 1+1</math> |
|||
|
To specialize a layout you can use predefined templates. All templates can be found at Category:Layout Template. For example:
This box will always be shown at the right side of a page and is also floated. |
{{Layout ForceDirected}}
|
|||
|
To bundle all specialties of a layout you have to use two templates. {{TplBoxTop}} and {{TplBoxBottom}}. For the TplBoxTop you can also include a name to be shown at the top of all. This could be the page name, included by {{PAGENAME}}, or the name you want to give to the layout. Between the two templates you can put as much layout templates as you want.
|
{{TplBoxTop|{{PAGENAME}}}}
{{Layout ForceDirected}}
{{TplBoxBottom}}
|
