Geeklog Assist plugin - UIkit
PHP HTML Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
BONUS
admin
custom_SAMPLE
javascript
language
lib
public_html
sql
templates
README
autoinstall.php
config.php
configuration_validation.php
fnc_staticpagecache.inc
functions.inc
functions_autotag.inc
functions_scheduled.inc
install_defaults.php
version.php

README

Geeklog Documentation
Geeklogドキュメント - Assist プラグイン
トップページ 管理画面

Assist プラグイン

Ver.1.1.0 history

ライセンス GNU GPLv2

旧版配布

正式版配布

最新テスト版配布

☆Version1.8.1未満のGeeklogでは使用できません。

☆Version5.1未満のMySQLでは使用できません。

☆テスト版での更新処理は原則バージョンの変更とコンフィギュレーション設定の更新のみおこなっています。

ドキュメント目次

インストール方法 (アップグレードの方法を含む)
設定(コンフィギュレーション)
自動タグ・ブロック用関数
ファイル構成
テーマ変数
概要

Geeklogサイトを種々補助するプラグインです
機能

ユーザー関連:インポート(メール通知なし)削除(ユーザーID範囲指定)
変数関連:擬似クーロン実行日を変更する
ニュースレター:記事をニュースレターとして送信。送信先を分けて送信予約も
Japanizeプラグインを先にロードしないと、日本語メールが文字化けする場合があります。
backup & restore :assistプラグインのコンフィギュレーションのbackup & restore 初期化 更新
いいねボタン等の自動タグ(テーマ変数)
facebookのいいねボタンを使用する場合は、Geeklogのコンフィギュレーション設定でFacebook OAuth Application IDの設定が必要です。
Topページ、記事、話題のトップのメタタグ編集(テーマ変数)
Geeklogのコンフィギュレーション設定のメタタグを有効にすると説明文のメタタグが登録できます。
関連プラグイン

Japanize :Assist プラグインよりも先にロードしてください。
メルマガユーザー(wkymimguser)
Maps professional版のみ
制限事項

英語言語ファイルがない場合の言語ファイルの既定値は日本語になっています。
文字コードはutfのみ対応しています。
MySQLのみ対応しています。
主にXrea仕様 および SaaSes サーバで動作作検証しています。
注意

Ver1.0 以前のバージョンのassistプラグインが存在する場合は、いったん アンインストール、削除してから、あらためてインストールしてください。

Ver1.0 以前のバージョンの自動タグは、原則、そのままでも使用できます。





インストール

データベースおよびファイルのバックアップをとります。
標準的なプラグインのファイル配置に従い、ファイルをアップします。
plugins/ 以下に assist以下をアップ
admin/plugins/assist/以下に admin以下のファイルを移動
public_html/assist/以下に public_html以下のファイルを移動
Rootユーザーとしてログインし,プラグイン管理の画面でインストールを実行します
その他必要なフォルダ&ファイル

public_html/assist_data (ファイル保存場所)
private/data/assist/ (ファイル保存場所)
上記は、コンフィギュレーション設定で変更可能です

インストール時に作成されるグループ

Assist Admin assist.admin Has full access to Assist features
インストール時に作成されるファイル

logs/assist_newsletter.log
ファイルがすでに存在する場合は、ファイル内容は削除されます。

実行時に作成されるファイル

data/assistconfig_bak.php  コンフィギュレーションのバックアッップ
data/assist_reserv_(予約日時) ニュースレターの予約ファイル
log/assistconfig_bak.php  コンフィギュレーションの更新時のバックアッップ
アンインストール方法

データベースおよびファイルのバックアップをとります。
Rootユーザーとしてログインし,プラグイン管理の画面で削除を実行します。
アップしたファイルを削除します。
アンインストールすると データベース上のAssist専用データ、ニュースレターの予約は、すべて削除されます。

通常のアップグレード方法

データベースおよびファイルのバックアップをとります。
標準的なプラグインのファイル配置に従い、ファイルをアップします。
plugins/ 以下に assist以下をアップ
admin/plugins/assist/以下に admin以下のファイルを移動
public_html/assist/以下に public_html以下のファイルを移動
Rootユーザーとしてログインし,プラグイン管理の画面で更新を実行します
基本的なテスト版のアップグレード方法

アンインストール、削除してから、あらためてインストールしてください。

アンインストールすると データベース上の専用データは、すべて削除されます。

テーブルの追加変更が必要な場合があります。

グループおよび権限の追加変更が必要な場合があります。

管理画面のバックアップ&リストアの画面でコンフィギュレーション仕様を最新に更新することができます。






設定
Assist プラグインの設定は、

コンフィギュレーション管理画面「管理者用メニュー - コンフィギュレーション - Assist」から変更できます。
メイン設定(2013/12/02 update)

項目(変数)	デフォルト	説明
タイトルの長さ(title_trim_length)	20	 
表示期間(日)(intervalday)	90(日)	 
表示件数(limitcnt)	10(件)	 
新着マーク表示期間(日)(newmarkday)	3(日)	 
デフォルトトピック(topics)	''	 
新着マーク(new_img)	<span class="assist_new">new!</span>  	旧デフォルト<img width='29' height='11' src='{$_CONF['site_url']}/assist/images/icon_new.gif' alt='NEW!' />
RSSマーク(rss_img)	<span class="databox_rss">RSS</span> 	旧デフォルト<img width='35' height='16' src='{$_CONF['site_url']}/assist/images/icon_RSS.gif' alt='RSS' class='icon_rss' > 
ニュースレタートピック(newsletter_tid)	newsletter	 
テンプレート 一般画面(templates)	標準(standard)	どのテンプレートフォルダを使用するかを指定します。
標準(standard)(デフォルト): private/plugins/assist/templates/以下
カスタム(custom): private/plugins/assist/custom/templates/以下
テーマ(theme): public_html/テーマ/テーマテンプレートパス/以下
注意: カスタムまたはテーマを指定している場合でもフォルダがなければ標準のテンプレートフォルダを使用します
テンプレート 管理画面(templates_admin)	標準(standard)	どのテンプレートフォルダを使用するかを指定します。
標準(standard)(デフォルト): private/plugins/assist/templates/以下
カスタム(custom): private/plugins/assist/custom/templates/以下
テーマ(theme): public_html/テーマ/テーマテンプレートパス/以下
注意: カスタムまたはテーマを指定している場合でもフォルダがなければ標準のテンプレートフォルダを使用します 
テーマテンプレートパス(themespath)	assist/templates/	テーマテンプレートを使用する場合、テーマからの相対パス 
assist用擬似Cronスケジュール間隔(cron_schedule_interval)	3600(秒)(=60分)	ニュースレターを疑似CRONで予約送信する場合に使用します 
管理者からのメール受信設定を表示する(準備中)(onoff_emailfromadmin)	1	 
保存後の画面遷移 一般画面(aftersave)	作成した項目を表示する(item)	保存した後、どのページに移動するかを指定します。
画面遷移なし(no): 移動しません。
作成した項目を表示する(item): 作成した記事を表示します。
項目一覧を表示する(list): 一覧を表示します。
ホームを表示する(home): サイトのHomeページ(トップページ)を表示します。
管理画面TOPを表示する(admin): 管理画面を表示します。
プラグイントップを表示する(plugin): プラグイントップを表示します。
 注意: 現在対象画面はありません 
保存後の画面遷移 管理画面(aftersave_admin)	作成した項目を表示する(item)	保存した後、どのページに移動するかを指定します。
画面遷移なし(no): 移動しません。
作成した項目を表示する(item): 作成した記事を表示します。
項目一覧を表示する(list): 一覧を表示します。
ホームを表示する(home): サイトのHomeページ(トップページ)を表示します。
管理画面TOPを表示する(admin): 管理画面を表示します。
プラグイントップを表示する(plugin): プラグイントップを表示します。
 
xmlns	xmlns:fb="http://www.facebook.com/2008/fbml" xmlns:og="http://ogp.me/ns#" xmlns:mixi="http://mixi-platform.com/ns#"	html に追加記述する内容  
デフォルト画像URL(default_img_url)	 	TOPページ等のメタタグ設定で使用します。
画像ファイルは、以下の要件を満たす必要があります。
縦横3:1以下の比率
50px × 50px以上
フォーマットはpng, jpg, gif
注:facebookのogp画像に使用する場合、200X200ピクセル以上、1500X1500ピクセル以下で
キャッシュファイルパス(path_cache)	/path/to/geeklog/data/cache/	キャッシュファイルを記憶するパスを指定します  
profesional版

項目(変数)	デフォルト	説明
XML一括インポートディレクトリ(path_xml)	$_CONF['path_html']."assist_data"	 
XMLエキスポートディレクトリ(path_xml_out)






自動タグ(2013/08/28 update)

書式	説明
[conf:変数名]	$_CONF[変数名] の値を返す
例1:[conf:site_url]
例2:[conf:site_name]
例3:[conf:site_mail]
例4:[conf:site_slogan]
[assist:usercount]	登録ユーザー数
[assist:usercount_location]	location登録ユーザー数
[assist:staticpage_content]	例1:[assist:staticpage_content] id=blockpageの静的ページを無条件に表示する
例2:[assist:staticpage_content id:xxxx urlkey:yyyy] urlまたはスクリプトの引数にyyyyを含む場合にidがxxxx の静的ページを表示する
例3:[assist:staticpage_content id:xxxx mode:home] ホームの場合にidがxxxx の静的ページを表示する
例4:[assist:staticpage_content id:xxxx mode:sub] ホーム以外の場合にidがxxxx の静的ページを表示する
例5:[assist:staticpage_content id:xxxx mode:except] 指定したキーワードを含まないサブページの場合にidがxxxx の静的ページを表示する
指定された静的ページを表示する権限のないユーザーがアクセスしている場合は表示されません
modeが指定されている場合 urlkeyの指定は無視されます
idが指定されていない場合は、blockpage が指定されたものとします
多言語サイトの場合、id:xxxx_jpの言語idは、urlの第一引数または現在の言語モードに基づき、自動的に変換されます。(第一引数優先)
[assist:user_homepage uid:9]	指定ユーザー(省略時ログインユーザー)のホームページ
[assist:user_location uid:9]	指定ユーザー(省略時ログインユーザー)の居住地
[assist:user_sig uid:9]	指定ユーザー(省略時ログインユーザー)の署名
[assist:user_photo uid:9 width:9 height:9]	指定ユーザー(省略時ログインユーザー)の写真
[assist:user_about uid:9 ]	指定ユーザー(省略時ログインユーザー)の自己紹介
[assist:user_pgpkey uid:9 ]	指定ユーザー(省略時ログインユーザー)のPGP鍵
[assist:uid]	ログインユーザーのuid
[assist:username uid:9]	指定ユーザー(省略時ログインユーザー)のユーザー名
[assist:fullname uid:9]	指定ユーザー(省略時ログインユーザー)の氏名
[assist:showgroup]	ログインユーザーの所属するグループ一覧出力
[assit:newstories 話題ID RSSファイルほか例1参照]	新着記事(おしらせ)
例1:[assist:newstories] 話題はコンフィギュレーション設定のデフォルトトピック、設定されてない場合はALL
例2:[assist:newstories topics:news rss_file:news.rss title_trim_length:50 intervalday:70 limitcnt:40 newmarkday:30 thtml:xxxx]
例3:話題news を全件表示 [assit:newstories topics:news intervalday:0]
例4:話題news を/テーマ/xxxx/ のテンプレートで表示 [assist:newstories topics:news thtml:xxxx]
例5:[assist:newstories topics:ALL] 全話題
例6:[assist:newstories topics:news|General] 話題の複数指定
[assit:home_id]	home または sub (言語ファイルで変更可)
[assit:login_status]	member または guest (言語ファイルで変更可)
[assit:topic_id]	現在の画面の話題ID
[assit:sp_id]	現在の画面の静的ページID
[assit:rss RSSファイルほか例1参照]	rss の表示
例1:[assist:rss urlrss:www.rentpro.co.jp/backend/databoxchintai.rss strip_tags:-1 description_trim_length:30 templatedir:aaa]
例2:[assist:rss]
[assist:btn typeほか例1参照 ]	ソーシャルボタン・ボックス の表示
例1:[assist:btn type:fblikebtn templatedir:aaa]
例2:[assist:btn type:evclip]
例3:[assist:btn type:fbcomment]
例4:[assist:btn type:tweet]
例5:[assist:btn type:plusone]
[assist:truncate text:x maxlen:9 filler:x endchars:9]	文字列を区切る
例1;[assist:truncate text:あいうえおかきくけこ maxlen:3]
例2;[assist:truncate text:あいうえおかきくけこ maxlen:3 filler:...]
例3;[assist:truncate text:あいうえおかきくけこ maxlen:1 filler:... endchars:3]
[assist:cache id:top type:staticpages]	キャッシュファイルを返す
例1;[assist:cache id:top]
例2;[assist:cache id:top type:staticpages]
キャッシュファイルは、キャッシュパス/type/id.html 
キャッシュファイルが存在しない場合は、空白を返します
[assist:staticpage]	例1:[assist:staticpage id:xxxx]
例2:[assist:staticpage id:xxxx linktext]
linktext が省略されている場合は、タイトルをlinktextとします。
linktext は、必ず最後に記述してください。半角スペースを含む内容も記述可能です。
該当ページがない場合もリンクは表示されます。
多言語サイトの場合、id:xxxx_jpの言語idは、urlの第一引数または現在の言語モードに基づき、自動的に変換されます。(第一引数優先)
ブロック用関数(2010/12/03 update)

関数名	説明
phpblock_shownewstories	 
phpblock_shownewstories_news	話題id=newsの新着記事の一覧を表示する
phpblock_showstaticpage	id=blockpageの静的ページを表示する
phpblock_showgroup	ログインユーザーの所属するグループ一覧出力






テーマ変数(2013/03/22	update)

画面	【フォルダ】テンプレート	テーマ変数
ソーシャルボタン・ボックス	【btn】  	currenturl,appid*1
headercode	【headercode】articles.thtml 記事	xhtml, site_url, currenturl, site_name, og_title, og_image *3 ,og_description, og_type facebook_consumer_key *1 
site_mail *2
【headercode】frontpage.thtml トップページ	xhtml, site_url, currenturl, site_name, og_title, og_image *4 ,og_description, og_type facebook_consumer_key *1 
site_mail *2
【headercode】topictop.thtml 話題トップページ	xhtml, site_url, currenturl, site_name, og_title, og_image *5 ,og_description, og_type facebook_consumer_key *1 
site_mail *2
newstories	【newstories】stories.thtml	rss_url,rss_title ,more_url,more_title
stories_col
【newstories】stories_col.thtml featuredstories_col.thtml(注目記事の場合)	day,new_img,url,title,meta_description,introtext
rss	【rss】rss.thtml rss_col.thtml	head_link,head_title,image_link,image_url,image_title, head_description, head_webmaster, head_copyright
rss_col
link,title,pubdate,description
PLG_templateSetVars(2014/03/31	update)

画面	【フォルダ】テンプレート	テーマ変数
PLG_templatesetvarsを使用している画面

COM_siteHeader(header.thtml)
COM_siteFooter(footer.thtml)
COM_createHTMLDocument
        (header.thtml,footer.thtml)
COM_userMenu(loginblock.thtml)	header.thtml
footer.thtml
storytext.thtml
loginblock.thtml
featuredstorytext.thtml
archivestorytext.thtml
ほか	language
languageid,_languageid言語ファイル[多言語モード]に登録されていない場合は表示されません
header.thtml	xmlns
xmlnsに登録されている内容を追加記述します
PLG_templatesetvarsを使用している画面
DataBox UserBox プラグイン	【category】list.thtml
【category】list_detail.thtml
【attribute】list.thtml
【attribute】list_detail.thtml
【data】list_detail.thtml
【profile】list_detail.thtml
{uid} {username} {fullname} {displayname}
ゲストユーザの場合は、null
*1 Geeklogのコンフィギュレーション設定でFacebook OAuth Application IDの設定が必要です。 
*2 標準テンプレートには記述されていません。 
*3 記事に添付した画像 またはAssistデフォルト画像 またはロゴ画像 
*4 Assistデフォルト画像 またはロゴ画像 
*5 話題アイコン またはAssistデフォルト画像 またはロゴ画像






Geeklogドキュメント作成プロジェクト、Geeklogドキュメント日本語版作成プロジェクト
本ページのすべての商標と著作権はそれぞれの所有者に帰属します。Geeklogはコピーレフトです。