[geeklog-hg] geeklog: Added documentation for the Filemanager

[geeklog-cvs at lists.geeklog.net]

changeset 9414:b569cb020bcb
url:  http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/rev/b569cb020bcb
user: Kenji ITO <mystralkk at gmail.com>
date: Sun Jan 12 16:09:54 2014 +0900
description:
Added documentation for the Filemanager

diffstat:

 public_html/docs/english/config.html  |  150 ++++++++++++++++++++++++++++++++
 public_html/docs/japanese/config.html |  155 +++++++++++++++++++++++++++++++++-
 2 files changed, 303 insertions(+), 2 deletions(-)

diffs (truncated from 347 to 300 lines):

diff -r fc6c672b7acf -r b569cb020bcb public_html/docs/english/config.html
--- a/public_html/docs/english/config.html	Sun Jan 12 16:09:18 2014 +0900
+++ b/public_html/docs/english/config.html	Sun Jan 12 16:09:54 2014 +0900
@@ -41,6 +41,7 @@
 <li><a href="#images">Images</a></li>
 <li><a href="#languages">Languages and Locale</a></li>
 <li><a href="#misc">Miscellaneous</a></li>
+<li><a href="#filemanager">File Manager</a></li>
 </ul>
 
 <h2><a name="site">Site</a></h2>
@@ -1837,6 +1838,155 @@
   <td valign="top">Set this to <code>true</code> to use the site name as the name of the breadcrumb root.</td></tr>
 </table>
 
+<h2><a name="filemanager">File Manager</a></h2>
+
+<p>Geeklog-2.1.0 integrated the <a href="https://github.com/simogeo/Filemanager">Filemanager</a>, an open-source file manager release under MIT license by Simon Georget.</p>
+<p>Only Root Admins, Story Admins and Static Page Admins can use the Filemanager on a fresh install.</p>
+
+<h3><a name="filemanager_general">File Manager: General Settings</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">Variable</th>
+    <th style="width:29%">Default Value</th>
+    <th style="width:63%">Description</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_disabled">filemanager_disabled</a></td>
+  <td valign="top">false</td>
+  <td valign="top">Set this to <code>true</code> to disable the Filemanager feature.  Still, those in the Root group can use it.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_browse_only">filemanager_browse_only</a></td>
+  <td valign="top">false</td>
+  <td valign="top">Set this to <code>true</code> to make the Filemanager read-only mode.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_default_view_mode">filemanager_default_view_mode</a></td>
+  <td valign="top">grid</td>
+  <td valign="top">Default view mode.  Possible options are 'grid' and 'list'.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_confirmation">filemanager_show_confirmation</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to show a confirmation message.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_search_box">filemanager_search_box</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to show a search box.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_file_sorting">filemanager_file_sorting</a></td>
+  <td valign="top">default</td>
+  <td valign="top">How to to specify output on ordering files/folders list.  Possible options are: 'Name (asc)', 'Name (desc)', 'Type (asc)', 'Type (desc)', 'Modified (asc)', and 'Modified (desc)'.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_chars_only_latin">filemanager_chars_only_latin</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to allow non-latin characters into folder names.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_date_format">filemanager_date_format</a></td>
+  <td valign="top">Y-m-d H:i:s</td>
+  <td valign="top">Format of the date to display.  See <a href="http://www.php.net/manual/en/function.date.php" title="Move to an external page in a new window" target="_blank">this page</a> for details.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_logger">filemanager_logger</a></td>
+  <td valign="top">false</td>
+  <td valign="top">If set to true, the Filemanager will log server-side actions into Geeklog's error file (error.log).</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_thumbs">filemanager_show_thumbs</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to show thumbnails.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_generate_thumbnails">filemanager_generate_thumbnails</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to generate thumbnails using PHP to increase performance on listing directory. Thumbnails are stored into the invisible folder '_thumbs'. If you want to make it visible, just remove it from unallowed_files configuration section.</td></tr>
+</table>
+
+<h3><a name="filemanager_upload">File Manager: Upload</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">Variable</th>
+    <th style="width:29%">Default Value</th>
+    <th style="width:63%">Description</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_restrictions">filemanager_upload_restrictions</a></td>
+  <td valign="top">'jpg', 'jpeg', 'gif', 'png', 'svg', 'txt', 'pdf', 'odp', 'ods', 'odt', 'rtf', 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', 'ogv', 'mp4', 'webm', 'ogg', 'mp3', 'wav'</td>
+  <td valign="top">Files with one of the above extensions will be allowed on upload.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_overwrite">filemanager_upload_overwrite</a></td>
+  <td valign="top">false</td>
+  <td valign="top">If set to true, files will be overwritten on uploads if they have same names. If set to false, an index will be added.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_images_only">filemanager_upload_images_only</a></td>
+  <td valign="top">false</td>
+  <td valign="top">If set to true, only images are accepted for upload.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_file_size_limit">filemanager_upload_file_size_limit</a></td>
+  <td valign="top">16</td>
+  <td valign="top">File size limit for HTML5 and the PHP connector file size check in MiB.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_files">filemanager_unallowed_files</a></td>
+  <td valign="top">'.htaccess'</td>
+  <td valign="top">An array of files excluded from listing.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_dirs">filemanager_unallowed_dirs</a></td>
+  <td valign="top">'_thumbs', '.CDN_ACCESS_LOGS', 'cloudservers'</td>
+  <td valign="top">An array of directories excluded from listing.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_files_regexp">filemanager_unallowed_files_regexp</a></td>
+  <td valign="top">'/^\\./uis'</td>
+  <td valign="top">Files excluded from listing, using a regular expression.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_dirs_regexp">filemanager_unallowed_dirs_regexp</a></td>
+  <td valign="top">'/^\\./uis'</td>
+  <td valign="top">Directories excluded from listing, using a regular expression.</td></tr>
+</table>
+
+<h3><a name="filemanager_images">File Manager: Images</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">Variable</th>
+    <th style="width:29%">Default Value</th>
+    <th style="width:63%">Description</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_images_ext">filemanager_images_ext</a></td>
+  <td valign="top">'jpg', 'jpeg', 'gif', 'png', 'svg'</td>
+  <td valign="top">An array of accepted images extensions.</td></tr>
+</table>
+
+<h3><a name="filemanager_videos">File Manager: Videos</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">Variable</th>
+    <th style="width:29%">Default Value</th>
+    <th style="width:63%">Description</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_video_player">filemanager_show_video_player</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to show browser video player.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_videos_ext">filemanager_videos_ext</a></td>
+  <td valign="top">'ogv', 'mp4', 'webm'</td>
+  <td valign="top">An array of videos extensions to embed in player.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_videos_player_width">filemanager_videos_player_width</a></td>
+  <td valign="top">400</td>
+  <td valign="top">Videos player width in pixels.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_videos_player_height">filemanager_videos_player_height</a></td>
+  <td valign="top">222</td>
+  <td valign="top">Videos player height in pixels.</td></tr>
+</table>
+
+<h3><a name="filemanager_audios">File Manager: Audios</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">Variable</th>
+    <th style="width:29%">Default Value</th>
+    <th style="width:63%">Description</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_audio_player">filemanager_show_audio_player</a></td>
+  <td valign="top">true</td>
+  <td valign="top">Whether to show browser audio player.</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_audios_ext">filemanager_audios_ext</a></td>
+  <td valign="top">'ogg', 'mp3', 'wav'</td>
+  <td valign="top">An array of audios extensions to embed in player.</td></tr>
+</table>
+
 <h2><a name="db-config.php">db-config.php</a></h2>
 
 <p>As the name implies, the file <tt>db-config.php</tt> contains the database
diff -r fc6c672b7acf -r b569cb020bcb public_html/docs/japanese/config.html
--- a/public_html/docs/japanese/config.html	Sun Jan 12 16:09:18 2014 +0900
+++ b/public_html/docs/japanese/config.html	Sun Jan 12 16:09:54 2014 +0900
@@ -16,9 +16,10 @@
 
 <h2>コンフィギュレーション用ファイル</h2>
 
-<p>旧バージョンのGeeklogでは、<tt>config.php</tt>という主要な設定を網ç¾
した巨大なファイルを使用していました。Geeklog 1.5.0では、設定の大部分はデータベースに記録され、管理è€
機能å†
の<b>コンフィギュレーション(Configuration)</b>からアクセスできるようになりました。</p>
+<p>旧バージョンのGeeklogでは、主要な設定を網ç¾
した<tt>config.php</tt>
+という巨大なファイルを使用していました。Geeklog 1.5.0では、設定の大部分はデータベースに記録され、管理è€
機能å†
の<b>コンフィギュレーション(Configuration)</b>からアクセスできるようになりました。</p>
 
-<p>技術上の理由で、依然としてファイルに保存するå¿
要のある設定もあります。そのような設定ファイルは次の2つです：</p>
+<p>技術上の理由で、依然としてファイルに保存するå¿
要のある設定もあります。次の2つです:</p>
 <ul>
 <li><a href="#db-config.php">db-config.php</a></li>
 <li><a href="#siteconfig.php">siteconfig.php</a></li>
@@ -38,6 +39,7 @@
 <li><a href="#images">画像(Images)</a></li>
 <li><a href="#languages">言語とロケール(Languages and Locale)</a></li>
 <li><a href="#misc">その他(Miscellaneous)</a></li>
+<li><a href="#filemanager">ファイルマネージャー(File Manager)</a></li>
 </ul>
 
 <h2><a name="site">サイト</a></h2>
@@ -1563,6 +1565,155 @@
   <td valign="top">サイト名をパンくずリストのルートにするを<code>true</code>にすると、サイト名をパンくずリストのルートにします。</td></tr>
 </table>
 
+<h2><a name="filemanager">ファイルマネージャー(File Manager)</a></h2>
+
+<p>Geeklog-2.1.0では、MITライセンスでSimon Georgetがå
¬é–‹ã—ているオープンソースのファイルブラウザー <a href="https://github.com/simogeo/Filemanager">Filemanager</a> を組み込みました。</p>
+<p>新規インストール時には、Root管理è€
、記事管理è€
(Story Admins)、静的ページ管理è€
(Static Page Admins)だけがファイルマネージャーを使用できます。</p>
+
+<h3><a name="filemanager_general">ファイルマネージャー: å
¨èˆ¬</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">é 
目(変数)</th>
+    <th style="width:29%">デフォルト</th>
+    <th style="width:63%">説明</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_disabled">ファイルマネージャーを無効にする(filemanager_disabled)</a></td>
+  <td valign="top">いいえ(false)</td>
+  <td valign="top"><code>はい(true)</code>にすると、Rootグループに所属するユーザー以外はファイルマネージャーを使用できなくなります。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_browse_only">閲覧のみ(filemanager_browse_only)</a></td>
+  <td valign="top">いいえ(false)</td>
+  <td valign="top"><code>はい(true)</code>にすると、ファイルマネージャーは閲覧専用になります。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_default_view_mode">表示モードの初期値(filemanager_default_view_mode)</a></td>
+  <td valign="top">グリッド</td>
+  <td valign="top">表示モードの初期値を指定します。可能なオプションは'グリッド'と'リスト'です。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_confirmation">確認メッセージを表示する(filemanager_show_confirmation)</a></td>
+  <td valign="top">はい(true)</td>
+  <td valign="top">はい(true)にすると、確認メッセージを表示します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_search_box">検索ボックスを表示する(filemanager_search_box)</a></td>
+  <td valign="top">はい(true)</td>
+  <td valign="top">はい(true)にすると、検索ボックスを表示します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_file_sorting">ファイルのソート方法(filemanager_file_sorting)</a></td>
+  <td valign="top">default</td>
+  <td valign="top">ãƒ•ã‚¡ã‚¤ãƒ«ãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®è¡¨ç¤ºé †ã®åˆæœŸå€¤ã‚’æŒ‡å®šã—ã¾ã™ã€‚å¯èƒ½ãªã‚ªãƒ—ã‚·ãƒ§ãƒ³ã¯ã€'デフォルト'、'名前(æ˜‡é †)'、'名前(é™é †)'、'種類(æ˜‡é †)'、'種類(é™é †)'、'変更日時(æ˜‡é †)'、'変更日時(é™é †)'です。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_chars_only_latin">ファイル名にラテン文字だけを許可する(filemanager_chars_only_latin)</a></td>
+  <td valign="top">はい(true)</td>
+  <td valign="top">はい(true)にすると、フォルダー名としてラテン文字しか使えなくなります。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_date_format">日付のフォーマット(filemanager_date_format)</a></td>
+  <td valign="top">Y-m-d H:i:s</td>
+  <td valign="top">日時の表示フォーマットを指定します。詳しくは、<a href="http://www.php.net/manual/ja/function.date.php" title="別ウィンドウで外部サイトを表示します" target="_blank">このページ</a>をご覧ください。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_logger">ロガーを有効にする(filemanager_logger)</a></td>
+  <td valign="top">いいえ(false)</td>
+  <td valign="top">はい(true)にすると、ファイルマネージャーはサーバー側の処理をGeeklogのエラーファイル(error.log)に記録します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_show_thumbs">サムネール画像を表示する(filemanager_show_thumbs)</a></td>
+  <td valign="top">はい(true)</td>
+  <td valign="top">はい(true)にすると、サムネール画像を表示します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_generate_thumbnails">サムネール画像を作成する(filemanager_generate_thumbnails)</a></td>
+  <td valign="top">はい(true)</td>
+  <td valign="top">はい(true)にすると、表示速度向上のためPHPã‚’ä½¿ç”¨ã—ã¦ã‚µãƒ ãƒãƒ¼ãƒ«ç”»åƒã‚’ä½œæˆã—ã¾ã™ã€‚ã‚µãƒ ãƒãƒ¼ãƒ«ç”»åƒã¯éš ã—ãƒ•ã‚©ãƒ«ãƒ€ãƒ¼ '_thumbs' に保存されます。このフォルダーを表示するには、「表示しないディレクトリ」オプションから、'_thumbs' を除いてください。</td></tr>
+</table>
+
+<h3><a name="filemanager_upload">ファイルマネージャー: アップロード</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">é 
目(変数)</th>
+    <th style="width:29%">デフォルト</th>
+    <th style="width:63%">説明</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_restrictions">許可するファイル拡張子(filemanager_upload_restrictions)</a></td>
+  <td valign="top">'jpg', 'jpeg', 'gif', 'png', 'svg', 'txt', 'pdf', 'odp', 'ods', 'odt', 'rtf', 'doc', 'docx', 'xls', 'xlsx', 'ppt', 'pptx', 'ogv', 'mp4', 'webm', 'ogg', 'mp3', 'wav'</td>
+  <td valign="top">アップロードできるファイルの拡張子を指定します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_overwrite">既存のファイルを上書きする(filemanager_upload_overwrite)</a></td>
+  <td valign="top">いいえ(false)</td>
+  <td valign="top">åŒåã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’ã‚¢ãƒƒãƒ—ãƒ­ãƒ¼ãƒ‰ã™ã‚‹å ´åˆã€ã¯ã„(true)にすると、既存のファイルを上書きします。いいえ(false)ã«ã™ã‚‹ã¨ãƒ•ã‚¡ã‚¤ãƒ«åã«ã‚¤ãƒ³ãƒ‡ãƒƒã‚¯ã‚¹ã‚’ä»˜åŠ ã—ã¾ã™ã€‚</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_images_only">画像ファイルだけをアップロードする(filemanager_upload_images_only)</a></td>
+  <td valign="top">いいえ(false)</td>
+  <td valign="top">はい(true)にすると、画像ファイルしかアップロードできなくなります。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_upload_file_size_limit">アップロードするファイルサイズの上限(filemanager_upload_file_size_limit)</a></td>
+  <td valign="top">16</td>
+  <td valign="top">HTML5とPHPコネクターでアップロードできるファイルサイズの上限をメガバイト単位で指定します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_files">表示しないファイル名(filemanager_unallowed_files)</a></td>
+  <td valign="top">'.htaccess'</td>
+  <td valign="top">表示しないファイル名を指定します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_dirs">表示しないディレクトリ(filemanager_unallowed_dirs)</a></td>
+  <td valign="top">'_thumbs', '.CDN_ACCESS_LOGS', 'cloudservers'</td>
+  <td valign="top">表示しないディレクトリ名を指定します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_files_regexp">表示しないファイル名の正規表現(filemanager_unallowed_files_regexp)</a></td>
+  <td valign="top">'/^\\./uis'</td>
+  <td valign="top">表示しないファイル名を正規表現で指定します。</td></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_unallowed_dirs_regexp">表示しないディレクトリ名の正規表現(filemanager_unallowed_dirs_regexp)</a></td>
+  <td valign="top">'/^\\./uis'</td>
+  <td valign="top">表示しないディレクトリ名を正規表現で指定します。</td></tr>
+</table>
+
+<h3><a name="filemanager_images">ファイルマネージャー: 画像</a></h3>
+
+<table border="1" width="100%">
+<tr><th style="width:8%">é 
目(変数)</th>
+    <th style="width:29%">デフォルト</th>
+    <th style="width:63%">説明</th></tr>
+<tr>
+  <td valign="top"><a name="desc_filemanager_images_ext">画像ファイルの拡張子(filemanager_images_ext)</a></td>