TEST Admidio Plugin Directory

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Written Communications ======

{{admidioplugins>info}}

==== Beschreibung ====
Dieses Plugin ermöglicht es Briefe und Serienbriefe zu erstellen. Basiernd auf einer *.docx Vorlage mit Platzhaltern (Template), generiert dieses Plugin ein komplettes *.docx Dokument und startet den Download der erstellten Datei. Das erstellte Dokument kann mit entsprechender Software auf dem PC weiter verarbeitet werden. Unterstützt werden MS Office, Open Office und Libre Office.

Das Plugin bietet die Möglichkeit über die Oberfläche individuelle Briefe an einen manuellen Empfänger, oder einen Serienbrief an eine Rolle innerhalb der Organisation zu erstellen. Als Standard wird die Adresse des Erstellers automatisch verwendet. Optional kann aber auch ein Absender manuell erstellt werden. Über den CKEditor können zusätzliche Styles des Textinhaltes formatiert werden. Ebenso werden Tabellen und Listen unterstützt. Nicht unterstützt werden das Einfügen von Bildern, sowie das Verwenden von Hyperlinks.

Das Plugin generiert anhand einer Vorlagendatei, welches das Format *.docx haben muss, eine aufbereitete Datei, in der alle Platzhalter durch die Benutzereingabe ersetzt werden. Das Plugin startet einen automatischen Download der erstellten *.docx Datei mit allen Seiten. Dadurch ist es möglich individuelle Vorlagen und Briefköpfe zu erstellen.  
 

==== Downloads ====
<WRAP download 60%>
{{admidioplugins>releases}}
</WRAP>

==== Screenshots ====
{{ :de:2.0:plg_wc_img1.jpg |}}

{{ :de:2.0:plg_wc_img2.jpg |}}


==== Installation ====
Keine Installation erforderlich. Das Plugin entpacken und in den Ordner adm_plugins kopieren. Link zum Plugin in das Admidio Menü in den Themes und in der Übersicht einfügen. 

==== Update ====
  * Im ersten Schritt solltest du die Datei **config.php** aus dem Pluginordner sichern.
  * Ersetze nun den vorhanden Pluginordner durch die Dateien der neuen Version.
  * Lade nun die gesicherte **config.php** in den Pluginordner und überschreibe die vorhandene Datei.

==== Update Admidio 3.2 ==== 
  * Ab Admidio 3.2 wurde die Rolle "Webmaster" in "Administrator" umbenannt und wird künftig entfernt.
  * Bitte aktualisiere diese Änderung in deiner config.php und ändere in:

<code php>
$plg_wc_roleArray = array('Administrator');
</code>


==== Zugriff auf Rollen beschränken ====

Zugriffsrechte können an Rollen gekoppelt werden. Die Einschränkung auf Rollen kann in der Datei config.php des Plugins konfiguriert werden. Hierzu muss die Rollenüberwachung mit dem Parameter $plg_wc_roleAccess = 1; aktiviert werden. Ist dieser Parameter gesetzt (Default:0 für alle Mitglieder der Organisation) dann wird der Zugriff auf die Rollen beschränkt, die im Array $plg_wc_roleArray in der config.php definiert wurden.
Um den Link nur für entsprechende Rollen sichtbar zu machen, verwende bitte die Admidio Funktion hasRole()
                                            

== Link sichtbar nur für den Webmaster und den Vorstand: ==
<code php>if(hasRole('Administrator') || hasRole('Vorstand'))
{
   $moduleMenu->addItem('written_communications','/adm_plugins/written_communications/written_communications.php','Brief erstellen', '/icons/page_white_word.png');
}</code>

==== Weitere Profilfelder im Plugin registrieren ====

Ab Version 1.1 können individuelle Profilfelder nach Wunsch zusätzlich registriert werden, die dann als Platzhalter im Template automatisch zur Verfügung stehen und genutzt werden können.
Um zusätzliche Profilfelder zu aktivieren müssen diese in der config.php des Plugins im Array $plg_wc_arrCustomProfileFields registriert werden. Hierzu definiere bitte das Profilfeld, welches genutzt werden soll, mit dem gewünschten Platzhalter im Template, als Key/Value Paar.
Beachte bitte, dass die Datenbankfelder in Großbuchstaben geschrieben werden müssen!

== Beispiel: ==
Um einen Platzhalter ${UserEmail} zu definieren muss dieser dem Profilfeld "EMAIL" zugewiesen werden:
   
<code php>
$plg_wc_arrCustomProfileFields = array('UserEmail' => 'EMAIL');
</code>

==== Feste Textknoten im Plugin registrieren ====

Ab Version 1.1 ist es möglich wiederkehrende Textpassagen und Texte, wie z.B. eine Grußformel, als festen Textknoten in Form eines Platzhalters zu definieren. Diese Texte werden im Array $plg_wc_arrCustomText in der config.php registriert. Zum Registrieren eigener Texte siehe: Weitere Profilfelder im Plugin registrieren.

==== Eigene Vorlagen und Briefpapiere erstellen ====

Zur Erstellung eigener Vorlagen ist das Plugin an das Downloadmodul von Admidio gekoppelt. 
Eigene Briefvorlagen sollten nicht in dem Beispiel Ordner "Templates" des Plugins erstellt werden, da dieser Ordner bei Updates ersetzt wird.
Im Download Modul sollte ein Ordner "MSWord_Templates" erstellt werden. Sobald ein solches Verzeichnis existiert wird dieser Ordner zur Auswahl automatisch genutzt. Jetzt können die eigenen Vorlagen bequem über den Upload bereitgestellt werden. Die Templates müssen das Format *.docx haben ! 

Die alten *.doc Formate und auch Vorlagenformate sind nicht zulässig!

Die zu verwendenden Platzhalter sind in den Demo Templates demo_de.docx und demo_en.docx im Ordner "templates" des Plugins enthalten. 
Die Platzhalter sind alle optional und können jederzeit entfernt werden, wenn ein Detail, z.B. das Datum "${LetterDate}" nicht in der Vorlage benötigt wird.

Wenn du ein schönes Template entworfen hast und du es gerne als Demo zur Verfügung stellen möchtest dann wende dich gerne ans Admidio Team.

==== Versionshistorie ====
//4.0.0 (06.11.2025)//
  * Compatibility with Admidio 5.0

//3.4.2 (02.11.2024)//
  * [Bug] Only show roles where the user has the right to view the membership

//3.4.1 (13.01.2024)//
  * Compatibility with Admidio 4.3

//3.4.0 (05.12.2021)//
  * Compatibility with Admidio 4.1

//3.3.3 (24.01.2021)//
  * [Bug] Output of street was not possible because of a rename of the internal field name

//3.3.2 & 3.2.2 (15.11.2020)//
  * PHP 7.4 compatibility
  * Update SimpleHtmlDom library to version 1.9.1

//3.3.1 (07.11.2020)//
  * Compatibility with Admidio 4.0

//3.2.1 (16.11.2018)//
  * Compatibility with Admidio 3.3

//3.1 (08.01.2017)//
  * Compatibility with Admidio 3.2
  * Changed folder path of the user tamplates to new organization folder names in the Download module.
  * Renamed "Webmaster" to "Administrator" in the config file ( $plg_wc_roleArray = array('Administrator'); ).

//3.0 (12.10.2016)//
  * Compatibility with Admidio 3.1
  * PHP7 ready
  * Language "de_sie" added
  * rework of Color style assignment

//2.0.1 (28.09.2015)//
  * Bugfix loading Admidio classes
  * Bugfix root path for template files
  * Internal name convention of variables and arrays

//2.0 (24.09.2015)//
  * Ready for Admidio 3.0
  * Common enhancements

//1.1 (18.08.2014)//
  * NEW FEATURES
  - Access to roles configurable in config file now
  - Customs profile fields can be registered in config file
  - Customs text fields can be registred in config file

//1.0.2 (29.06.2014)//
  * Bugfix openbase_dir settings causes errors
  * Bugfix Prefix of temporary file changed to "zip"

//1.0.1 (22.04.2014)//
  * Bugfix Wrong spelling of role class

//1.0 (13.04.2014)//
  * Modul Written Communications released