forked from thomas-rcv/admidio-written_communications
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme_en.txt
93 lines (50 loc) · 3.06 KB
/
readme_en.txt
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
/*************************************************************************************
* Plugin Written communications documentation
*
* Copyright : (c) 2004 - 2017 The Admidio Team
* Homepage : http://www.admidio.org
* Author : Thomas-RCV
* License : GNU Public License 2 http://www.gnu.org/licenses/gpl-2.0.html
* Version : 3.1
*
************************************************************************************/
This Plugi generates letters and written communicatins. Based on a *.docx template with placeholders,
the final document will be created and the download starts automatically.
The document can be used with specific software supporting open xml format (docx) .
Software MS Office, Open Office and Libre Office.
1. System Requirements
----------------------
- Admidio Version 2.4.4 odr higher
2. Installation
---------------
- no installation nescessary.
- Copy the extracted plugi folder in adm_plugins.
- Add the Link to the plugin to the Admidio Menue in the used theme.
Example:
---------
Add the link to the plugin at the end of the Admidio menue in the script "my_body_bottom.php"
$moduleMenu->addItem('written_communications', '/adm_plugins/written_communications/written_communications.php',
'Brief erstellen', '/icons/page_white_word.png');
Access to the plugin can be assigned to roles. Please use the Admidio function hasRole()
Example for only access for role Webmaster and chairman of the organization:
----------------------------------------------------------------------------
if(hasRole('Administrator', 'Chairman')
{
$moduleMenu->addItem('written_communications', '/adm_plugins/written_communications/written_communications.php',
'Brief erstellen', '/icons/page_white_word.png');
}
3. Updates
----------
- All scripts and folders are replaced if an update is released.
NOTICE: Since Admidio Version 3.2 the role name "Webmaster" has changed to "Administrator" and will be removed in future.
To avoid script errors, please update your config. php of the plugin and change the role access to $plg_wc_roleArray = array('Administrator');, if you use it.
4. Creating own templates:
---------------------------------
Creating an using own templates, the plugin is connected to the Admdido download module.
It is not recommended using own templates in the demo template directory of the plugin.
Caused by an update the folder may be replaced, too.
- Create a folder "MSWord_Templates" in the download module. If exists the plugin switches the path to it automatically.
- Own Templates can be provided in this directory using the upload sequence. Also FTP transmitting is possible.
The templates must have the *.docx format!
Old formats like *.doc and also template formats are not supported!
- Used placeholders can be seen in the demo templates demo_de.docx und demo_en.docx int the folder "templates" of the plugin.