1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Remmina - The GTK+ Remote Desktop Client: Contribute-to-the-Remmina-documentation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="org.remmina.Remmina.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Remmina - The GTK+ Remote Desktop Client
 <span id="projectnumber">v1.4.33</span>
</div>
<div id="projectbrief">Remmina is a remote desktop client written in GTK+, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large monitors or tiny netbooks. Remmina supports multiple network protocols in an integrated and consistent user interface. Currently RDP, VNC, NX, XDMCP and SSH are supported.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('md__builds__remmina_remmina-ci__remmina_8wiki__contribution__contribute-to-the-_remmina-documentation.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Contribute-to-the-Remmina-documentation </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Remmina lacks good usage and development documentation.</p>
<p>If you don't have the right permissions to add and/or edit a wiki page, just submit a <a href="https://gitlab.com/Remmina/Remmina/-/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=">New issue</a> or send an email to <a href="https://lists.remmina.org/listinfo/users">our mailing list</a>.</p>
<h2>Usage documentation</h2>
<p>In the future we would like to have an offline user manual generated out of the wiki, therefore it's important to get a useful and updated wiki ASAP.</p>
<p>Contribute to the wiki you either editing an existing page, or creating new ones.</p>
<p>To create a new page, click <a href="https://gitlab.com/Remmina/Remmina/-/wikis/new">New page</a>, in the title specify the relative path of the page you want to create.</p>
<p>For instance, if you want to create a page on "How to share your local printers" under the Usage section, you will set the title as <code>Usage/How-to-share-your-local-printers</code>.</p>
<p>When you are done, update the sidebar links <a href="https://gitlab.com/Remmina/Remmina/-/wikis/_sidebar">https://gitlab.com/Remmina/Remmina/-/wikis/_sidebar</a> and the section page (e.g. <a href="https://gitlab.com/Remmina/Remmina/-/wikis/Usage">https://gitlab.com/Remmina/Remmina/-/wikis/Usage</a>).</p>
<p>That's all!</p>
<p>If you prefer to work from a terminal, the wiki can be <a href="https://gitlab.com/Remmina/Remmina/-/wikis/git_access">cloned</a></p>
<h2>Developer documentation</h2>
<p>We try to document the code as much as we can, but often lack the time and/or some quick-fixes would require documenting a large amount of code.</p>
<p>If you are writing new code, try to document it. If you are not a developer, but would like to learn, documenting the code is hard, but an extremely effective way to learn.</p>
<p>We use <a href="https://www.doxygen.nl/index.html">Doxygen</a>, the documented code is automatically deployed on <a href="https://remmina.gitlab.io/remminadoc.gitlab.io/">https://remmina.gitlab.io/remminadoc.gitlab.io/</a> , a good example, if you don't have Doxygen experience is <a href="https://gitlab.com/Remmina/Remmina/-/blob/master/src/remmina_stats.c,">https://gitlab.com/Remmina/Remmina/-/blob/master/src/remmina_stats.c,</a> that renders as <a href="https://remmina.gitlab.io/remminadoc.gitlab.io/remmina__stats_8c.html">https://remmina.gitlab.io/remminadoc.gitlab.io/remmina__stats_8c.html</a></p>
<p>Don't be afraid and/or lazy and ask for help in our IRC channel if you have troubles. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|
