<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<title>RealBlog Kurzdoku</title>
<meta name="content-language" content="de">
<style type="text/css">
body {min-width: 880px; background: #d9d6d0; font-family: arial, sans-serif; font-size: 15px;}
div#main {background: #fff; width: 740px; line-height: 1.5em; border: 1px solid #999; border-radius: 5px; padding: 10px 50px; margin: 20px auto;}
.code {font-family: Courier New; border: 1px solid #999; background: #eed; padding: 8px 12px;}
li {padding-top: 5px; padding-bottom: 5px;}
</style>
</head>

<body>
<!-- utf-8 check: äöü -->

<div id="main">
<h1>Kurz-Dokumentation Plugin "RealBlog"</h1>
<p><b><i>Version RealBlog 4.3 - 2022-03</i></b></p>
<p>Eine Dokumentation in deutscher Sprache finden Sie unter <a href="http://www.ge-webdesign.de/cmsimplerealblog/?Dokumentation:RealBlog">ge-webdesign.de/cmsimplerealblog/</a></p>
<p>Das Plugin "RealBlog" ist eine Weiterentwicklung des Plugins AdvancedNews von Jan Kanters. Vielen Dank an dieser Stelle noch einmal an Jan für die Erlaubnis, den Code seines Plugins AdvancedNews als Basis für die Entwicklung des Plugins "RealBlog" zu verwenden.</p>

<p>&#160;</p>

<h2>1. Funktionen:</h2>
<ul>
    <li>Blog-Funktion, chronologische Verwaltung der Beiträge </li>
    <li>Archiv-Funktion, Jahres- und Monatsarchive</li>
	<li>Kategorien</li>
    <li>RSS-feed <span style="color: #900">(veraltet - keine weitere Entwicklung)</span></li>
    <li>Artikel-Status: nicht veröffentlicht - veröffentlicht - archiviert - gesichert</li>
    <li>Zeitgesteuerte Veröffentlichung und Archivierung</li>
    <li>WYSIWYG Editoren für Teaser und Artikel</li>
	<li>Erweiterbar mit dem Plugin <b>Comments</b>, Beiträge sind dann kommentierbar. Die Kommentarfunktion kann für jeden einzelnen Artikel aktiviert oder deaktiviert werden.</li>
	<li>Wenn die Plugins <b>MembersArea</b> und <b>Comments 3.3</b> oder höher installiert sind, kann das Kommentarformular für nicht eingeloggte Besucher und Mitglieder der Gruppe für neu registrierte Mitglieder ausgeblendet werden.</li>
	<li>Stapelsicherung der Datendatei realblog.txt, Anzahl der Backups konfigurierbar</li>
</ul>
<p>&#160;</p>





<h2>2. Systemvoraussetzungen</h2>
<p>Voraussetzung ist eine funktionierende Installation von CMSimple 4.2 oder höher.</p>
<p>Für Kommentare muss das Plugin "Comments" installiert sein.</p>
<p>&#160;</p>





<h2>3. Installation</h2>
<ol>
    <li>zip-Datei herunterladen und mit einem geeigneten Programm entpacken</li>
    <li>Laden Sie alle Ordner und Dateien des Verzeichnisses CMSimpleRoot in das Verzeichnis, in dem sich Ihre CMSimple-Installation befindet. Das kann in einem Zug passieren, indem Sie den Inhalt des Verzeichnisses "CMSimpleRoot" in das Root-Verzeichnis Ihrer CMSimple-Installation hochladen, es werden keine vorhandenen Dateien überschrieben.</li>
    <li>Vergeben mit Ihrem ftp-Programm die erforderlichen Lese- und Schreibrechte.</li>
</ol>
<p>&#160;</p>





<h2>4. Datei- und Ordnerrechte</h2>
<p>Damit das Programm funktioniert und arbeiten kann, müssen auf älteren Servern evtl. für bestimmte Dateien und Ordner bestimmte Schreib- und Leserechte vergeben werden.</p>
<p>Folgende Ordner und Dateien müssen beschreibbar sein:</p>
<h3>Ordner / Verzeichnisse: chmod 777</h3>
<ul>
    <li><span style="font-family: Courier New;">./content/<b>realblog</b></span></li>
</ul>
<h3>Dateien: chmod 666</h3>
<ul>
    <li><span style="font-family: Courier New;">./content/realblog/<b>alle .txt-Dateien</b></span></li>
    <li><span style="font-family: Courier New;">./plugins/realblog/config/<strong>config.php</strong></span></li>
    <li><span style="font-family: Courier New;">./plugins/realblog/css/<strong>stylesheet.css</strong></span></li>
    <li><span style="font-family: Courier New;">./plugins/realblog/languages/<strong>alle xx.php-Dateien (Sprachdateien)</strong></span></li>
</ul>
<p>&#160;</p>





<h2>5. Funktionsaufrufe</h2>
<p>Auf den Seiten, auf denen Ihr WebLog oder Ihr Archiv laufen sollen, oder auf der Sie einen RSS-feed <span style="color: #900">(veraltet - keine weitere Entwicklung) </span>anbieten wollen, müssen Sie den entsprechenden Funktionsaufruf auf der Seite einfügen, am besten direkt unter der Hauptüberschrift:</p>
<p>&#160;</p>



<h3>5.1 Weblog:</h3>
<p class="code">{{{PLUGIN:showrealblog();}}}</p>
<p>oder mit aktivierter Suchfunktion:</p>
<p class="code">{{{PLUGIN:showrealblog('showsearch=true');}}}</p>
<p>Auf dieser Seite werden dann die Artikel aller Kategorien ausgegeben.</p>
<p>&#160;</p>



<h3>5.2 Kategorien:</h3>
<p>Die Artikel können nach Kategorien gefiltert ausgegeben werden. Dazu muss auf den entsprechenden CMSimple Seiten im Plugin Aufruf ein 2. Parameter angegeben werden.</p>
<p>Ohne Suchfunktion:</p>
<p class="code">{{{PLUGIN:showrealblog('','Die_Kategorie');}}}</p>
<p>Mit Suchfunktion:</p>
<p class="code">{{{PLUGIN:showrealblog('showsearch=true','Die_Kategorie');}}}</p>
<p>Auf dieser Seite werden dann nur die Artikel der entsprechenden Kategorie ausgegeben.</p>


<h4>Kategorien für Artikel definieren:</h4>
<p>Die Kategorie, in der ein Artikel veröffentlicht werden soll, wird im Teaser oder im Artikel per Funktionsaufruf definiert:</p>
<p class="code">{{{PLUGIN:rbCat('|Kategorie_1|');}}}</p>
<p>Ein Artikel kann in mehreren Kategorien veröffentlicht werden:</p>
<p class="code">{{{PLUGIN:rbCat('|Kategorie_1|Kategorie_2|');}}}</p>
<p>Vor, hinter und zwischen den Kategorien muss ein senkrechter Strich ("|") notiert werden.</p>
<p>&#160;</p>



<h3>5.3 Überschriften:</h3>
<p>Die Überschriften im Teaser und im Artikel sind traditionell als h4 ausgezeichnet, wenn h1only_pagesplitting aktiv ist als h2. SEO-Spezialisten können das jetzt mit einem 3. Parameter im Plugin Aufruf ändern, Beispiel:</p>
<p class="code">{{{PLUGIN:showrealblog('showsearch=true','all','h1');}}}</p>
<p>Mit diesem Plugin Aufruf ist die Suchfunktion aktiv, es werden alle Kategorien angezeigt und die Überschriften der Teaser und der Artikel als h1 ausgezeichnet.</p>
<p>&#160;</p>



<h3>5.4 Sortierung:</h3>
<p>Die Sortierung der Artikel in der Artikelübersicht kann mit einem 4. Parameter unabhängig von der Plugin Konfiguration definiert werden, Beispiel:</p>
<p class="code">{{{PLUGIN:showrealblog('showsearch=true','all','h2','desc');}}}</p>
<p>Mit diesem Plugin Aufruf ist die Suchfunktion aktiv, es werden alle Kategorien angezeigt, die Überschriften der Teaser und der Artikel als h2 ausgezeichnet und die neuesten Artikel erscheinen oben.</p>
<p>Der 4. Parameter kann folgende Werte haben:</p>
<ul>
<li><b>desc</b> - Neueste Artikel oben</li>
<li><b>asc</b> - Älteste Artikel oben</li>
<li><b>user</b> - Selectbox über der Artikelübersicht</li>
</ul>
<p>&#160;</p>



<h3>5.5 Archiv:</h3>
<p class="code">{{{PLUGIN:showrealblogarchive();}}}</p>
<p>&#160;</p>



<h3>5.6 RealblogLink:</h3>
<p>Diese Funktion wird im Template verwendet (meist in einer Sidebar) und zeigt Links zu den letzten Blogartikeln an. Wie viele angezeigt werden, können Sie in der Plugin Konfiguratiopn festlegen.</p>
<p class="code">&lt;?php echo realbloglink('realblogpage=Die_Blog_Seite');?&gt;</p>
<p>&#160;</p>



<h3>5.7 RSS-feed:</h3>
<p style="color: #900">Die RSS Funktion hat den Status "veraltet (deprecated)", es ist keine weitere Entwicklung oder Anpassung an irgendwelche Entwicklungen geplant.</p>
<p class="code">{{{PLUGIN:realblog_rss_adv('replace=true');}}}</p>
<p>Der RSS Feed wird immer von allen Beiträgen erstellt. RSS Feeds für einzelne Kategorien sind zur Zeit nicht möglich.</p>
<p>Deshalb sollte auf der Website eine Seite sein, auf der alle Kategorien angezeigt werden. Diese Seite sollte in der Sprachdatei als rss_page: angegeben werden.</p>
<p>&#160;</p>



<h3>5.8 Kommentarfunktion nur für Mitglieder</h3>
<p>Wenn die Plugins <b>MembersArea</b> und <b>Comments 3.3</b> oder höher installiert sind, kann das Kommentarformular für nicht eingeloggte Besucher und Mitglieder der Gruppe für neu registrierte Mitglieder ausgeblendet werden. Die Kommentare bleiben für alle sichtbar.</p>
<p>Das kann global für alle Beiträge in der Konfiguration festgelegt werden, oder für jeden Beitrag einzeln per Funktionsaufruf im Artikel (nicht im Teaser!):</p>
<p class="code">{{{PLUGIN:CommentsMembersOnly();}}}</p>
<p>Wird dieser Funktionsaufruf auf der CMSimple Seite (<b>VOR</b> dem Plugin Aufruf) gesetzt, ist er für alle Artikel dieser Seite (Blog oder Kategorie) wirksam.</p>
<p><span style="color: #900">Hinweis: fügen Sie diesen Code in der Quelltext-Ansicht ein. Prüfen Sie, ob Formatierungen im Code enthalten sind und entfernen Sie diese ggf.</span></p>
<p>&#160;</p>





<h2>6. Konfiguration</h2>
<p>Wenn Sie in CMSimple eingeloggt sind, finden Sie oben im Admin Menü den Punkt "Plugins". Wählen Sie hier "Realblog".</p>
<p>Jetzt öffnet sich das Plugin-Menü, wählen Sie hier "RealBlog Konfiguration".</p>
<p>Bei den verschiedenen Einstellungs-Möglichkeiten finden Sie jeweils ein kleines blaues Fragezeichen-Symbol. Gehen Sie mit der Maus auf das entsprechende Fragezeichen-Symbol, und Sie erhalten Informationen über die entsprechende Konfigurationsmöglichkeit.</p>

<h3>RSS Feed </h3>
<p style="color: #900">Die RSS Funktion hat den Status "veraltet (deprecated)", es ist keine weitere Entwicklung oder Anpassung an irgendwelche Entwicklungen geplant.</p>
<p>Die meisten Einstellungen zum RSS Feed finden Sie in der Sprachdatei. Die Sprachdatei können Sie bearbeiten, wenn Sie im Plugin Menü auf "RealBlog Sprache" klicken.</p>
<p>&#160;</p>





<h2>7. Mehrere Blogs in Zweitsprachen und Subsites</h2>
<p>Ab der Version 2.0 können auch Blogs in Zweitsprachen und Subsites betrieben werden.</p>

<h3>7.1 Die RealBlog Daten</h3>
<p>Die Daten werden im content-Verzeichnis der jeweiligen Zweitsprachen oder Subsites abgelegt. Sie müssen also das Verzeichnis "content" aus dem RealBlog Download in das Verzeichnis der Zweitsprache oder Subsite hochladen und die Schreibrechte vergeben, so wie im content Verzeichnis der Hauptinstallation.</p>

<h3>7.2 Die RSS Feed Datei</h3>
<p style="color: #900">Die RSS Funktion hat den Status "veraltet (deprecated)", es ist keine weitere Entwicklung oder Anpassung an irgendwelche Entwicklungen geplant.</p>
<p>Die RSS Feed Datei "realblog_rss_feed.xml" liegt im CMSimpleRoot bzw. im Root Verzeichnis der Subsites und Zweitsprachen.</p>
<p><span style="font-family: Courier New;">./realblog_rss_feed.xml</span></p>
<p><span style="font-family: Courier New;">./fr/realblog_rss_feed.xml</span></p>
<p><span style="font-family: Courier New;">./subsite/realblog_rss_feed.xml</span></p>
<p><span style="font-family: Courier New;">usw.</span></p>
<p>Alle newsfeed Dateien müssen beschreibbar sein (chmod 666).</p>
<p>Als Vorlage können Sie die Datei</p>
<p><span style="font-family: Courier New;">./plugins/realblog/rss/realblog_rss_feed_template.xml</span></p>
<p>benutzen.</p>
<p>&#160;</p>




<h2>8. Stapelsicherung</h2>
<p>Ab der Version 4.0 wird bei jedem Speichervorgang ein Backup der Datendatei realblog.txt angelegt. Die maximale Anzahl der Backups ist konfigurierbar. Ist die maximale Anzahl der Backups erreicht, wird das älteste Backup gelöscht.</p>
<p>Die Backups werden im folgenden Verzeichnis abgelegt:</p>
<p><b>ab RealBlog 4.0:</b> <span style="font-family: Courier New;">./content/realblog/backups/</span></p>
<p><b>ab RealBlog 4.3:</b> <span style="font-family: Courier New;">./backups/realblog/</span></p>


<br>
</div>



</body>
</html>
