-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathhelp.htm
152 lines (137 loc) · 4.09 KB
/
help.htm
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<title>Pfw_XH – User Manual</title>
<link rel="stylesheet" type="text/css" href="./stylesheet.css">
</head>
<body>
<article>
<h1>Pfw_XH – User Manual</h1>
<img src="../pfw.png" style="float:left; margin: 0 1.5em 0.5em 0" alt="Whirling Magic Wand">
<p>
Pfw_XH is a plugin framework for CMSimple_XH packaged as CMSimple_XH plugin.
</p>
<nav id="nav">
<h2>Table of Contents</h2>
<ul>
<li><a href="#notice">Important Notice</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#settings">Settings</a></li>
<li><a href="#usage">Usage</a></li>
<li><a href="#license">License</a></li>
<li><a href="#credits">Credits</a></li>
</ul>
</nav>
<section id="notice">
<h2>Important Notice</h2>
<p class="important">
Pfw_XH hasn't been tested so far in various environments, and its API is not
stable yet. It is a so called alpha version. Use with caution!
</p>
</section>
<section id="requirements">
<h2>Requirements</h2>
<p>
Pfw_XH requires CMSimple_XH ≥ 1.6.3 and PHP ≥ 5.4.0.
</p>
</section>
<section id="installation">
<h2>Installation</h2>
<p>
The installation is done as with many other CMSimple_XH plugins. See the <a
href="http://www.cmsimple-xh.org/wiki/doku.php/installation">
CMSimple_XH wiki</a> for further details.
</p>
<ol>
<li class="important">
Backup the data on your server.
</li>
<li>
Unzip the distribution on your computer.
</li>
<li>
Upload the whole directory <code>pfw/</code> to your server into
CMSimple_XH's <code>plugins/</code> directory.
</li>
<li>
Set write permissions for the subdirectories <code>css/</code> and
<code>languages/</code>.
</li>
<li class="important">
Browse <i>Plugins</i> → <i>Pfw</i> and check if all requirements are
fulfilled.
</li>
</ol>
</section>
<section id="settings">
<h2>Settings</h2>
<p>
The plugin's configuration is done as with many other CMSimple_XH plugins in
the website's back-end. Select <i>Plugins</i> → <i>Pfw</i>.
</p>
<!--
<p>
You can change the default settings of Pfw_XH under <i>Config</i>. Hints for
the options will be displayed when hovering over the help icon with your
mouse.
</p>
-->
<p>
Localization is done under <i>Language</i>. You can translate the character
strings to your own language, if there is no appropriate language file
available, or customize them according to your needs.
See also <a
href="http://3-magi.net/plugins/pfw/pfw-sdk/docs/md_docs_native_language_support.html">Native
Language Support</a>.
</p>
<p>
The look of Pfw_XH can be customized under <i>Stylesheet</i>.
</p>
</section>
<section id="usage">
<h2>Usage</h2>
<p>
This plugin doesn't have any own functionality. It serves as framework and
toolkit for other plugins. Documentation for plugin developers can be found
in the <a href="http://3-magi.net/?CMSimple_XH/Pfw_XH/SDK">SDK</a>.
Translators should read the the chapter on <a
href="http://3-magi.net/plugins/pfw/pfw-sdk/docs/md_docs_native_language_support.html">Native
Language Support</a>.
</p>
</section>
<section id="license">
<h2>License</h2>
<p>
Pfw_XH is licensed under <a
href="http://www.gnu.org/licenses/gpl.html">GPLv3</a>.
</p>
<p>
© 2016-2017 Christoph M. Becker
</p>
</section>
<section id="credits">
<h2>Credits</h2>
<p>
The plugin logo is designed by <a
href="http://schollidesign.deviantart.com/">schollidesign</a>. Many thanks
for publishing this icon under LGPLv3.
</p>
<p>
Many thanks to the community at the <a
href="http://www.cmsimpleforum.com/">CMSimple_XH forum</a> for tips,
suggestions and testing.
Special thanks to <i>Holger</i> for encouraging the further development of
Pfw_XH.
</p>
<p>
And last but not least many thanks to <a href="http://harteg.dk/">Peter
Harteg</a>, the "father" of CMSimple, and all developers of <a
href="http://www.cmsimple-xh.org/"> CMSimple_XH</a> without whom this
amazing CMS wouldn't exist.
</p>
</section>
</article>
</body>
</html>