summaryrefslogtreecommitdiff
path: root/HACKING
blob: 3970b4656ee6aecd26b6507c0ad0deb4b09b6bd3 (plain)
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
mate-user-guide
===============

This module is for end-user documents with general MATE applicability 
only.  It will be shipped as the mate-user-guide package. It is possible
that "Help" and or links to individaul packages/modules/applications will show
up here as well.


Documentation for Doc Writers/Contributors
-----------------------------

For help on editing documentation, see the following pages:
http://wiki.mate-desktop.org/dev-doc

If you want to hack on the documentation, don't forget to Join the MATE
Documentation Project:
http://wiki.mate-desktop.org/dev-doc

Please do not forget to check the status here:
http://wiki.mate-desktop.org/status:doc-team

Any file that is edited needs to have the following in the header below the
<revision...> tag, above any similiar entries, preferably separated by a blank
line on both sides. Of course your own entry may go directly beneath this one,
with an <email> tag if desired:

    <credit type="author">
      <name>Mate Documentation Team</name>
    </credit>

Directory Structure
-------------------

Please respect the directory structure:
  mate-user-guide/<docname>/C/<docname>.page(stub,tmpl)
  mate-user-guide/<docname>/C/figures/
  mate-user-guide/<docname>/C/template/

In some cases, it may make sense to nest things one level deeper.  However,
do not nest things less deep.

The entire MATE Development Team appreciates your help and interest.