automatic 12.4.0 → 12.6.0

data/doc/PLUGINS

@@ -7,6 +7,12 @@ SubscriptionFeed
 [Path]
  /plugins/subscription/feed.rb
 
+[Input]
+ None
+
+[Output]
+ Feed
+
 [Abstract]
  Subscribe to feed.
 
@@ -23,6 +29,12 @@ FilterReverse
 [Path]
  /plugins/filter/reverse.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  Sort feed by date asc.
 
@@ -35,6 +47,12 @@ FilterIgnore
 [Path]
  /plugins/filter/ignore.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  To exclude the NG word.
 
@@ -46,17 +64,23 @@ FilterIgnore
         - KEYWORD ...
 
 
-FilterImage
-------------
+FilterImageSource
+-----------------
 [Path]
- /plugins/filter/image.rb
+ /plugins/filter/image_source.rb
+
+[Input]
+ Feed
+
+[Output]
+ Feed
 
 [Abstract]
- Rewrite the permalink to link of the image in the contents.
- If there is no link of image, the permalink will be nil.
+ Rewrite the permalink to source of the image in the contents.
+ If there is no source of image, the permalink will be nil.
 
 [Syntax]
-  - module: FilterImage
+  - module: FilterImageSource
 
 
 FilterTumblrResize
@@ -64,6 +88,12 @@ FilterTumblrResize
 [Path]
  /plugins/filter/tumblr_resize.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  To rewrite the permalink to the maximum size of
  the Tumblr (High Res).
@@ -80,12 +110,18 @@ StorePermalink
 [Path]
  /plugins/store/permalink.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
- To save a permanent link.
+ Save a permanent link.
  The duplicate permalink will be discarded.
 
 [Syntax]
-  - module: StoreBookmark
+  - module: StorePermalink
     config:
       db: DB_NAME
 
@@ -95,8 +131,14 @@ StoreFullText
 [Path]
  /plugins/store/full_text.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
- To save a full text of contents.
+ Save a full text of contents.
 
  Saved text can be viewed in the viewer below
  https://github.com/id774/blog_viewer
@@ -112,8 +154,14 @@ StoreTargetLink
 [Path]
  /plugins/store/target_link.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
- To store target locally.
+ Store target locally.
  This emulate "Right click to save".
 
 [Syntax]
@@ -128,6 +176,12 @@ PublishConsole
 [Path]
  /plugins/publish/console.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  Output pipeline to the console.
 
@@ -140,6 +194,12 @@ PublishHatenaBookmark
 [Path]
  /plugins/publish/hatenabookmark.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  To Hatena Bookmark (Social Bookmark).
 
@@ -160,13 +220,19 @@ PublishGoogleCalendar
 [Path]
  /plugins/publish/google_calendar.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  To register an appointment to Google Calendar.
 
 [Description]
  Register item.title to Google Calendar.
 
-[Notation recipe]
+[Syntax]
   - module: PublishGoogleCalendar
     config:
       username: GOOGLE_ACCOUNT
@@ -179,6 +245,12 @@ NotifyIkachan
 [Path]
  /plugins/notify/ikachan.rb
 
+[Input]
+ Feed
+
+[Output]
+ Feed
+
 [Abstract]
  To send a message to ikachan.
 
@@ -199,7 +271,13 @@ NotifyIkachan
 CustomFeedSVNLog
 ----------------
 [Path]
- /plugins/custom/feed_svn_log.rb
+ /plugins/custom_feed/svn_log.rb
+
+[Input]
+ None
+
+[Output]
+ Feed
 
 [Abstract]
  Get new revision info from SVN.
@@ -207,11 +285,110 @@ CustomFeedSVNLog
 [Description]
  To get the number that is specified by fetch_items.
 
-[Notation recipe]
-  - Module: CustomFeedSVNLog
+[Syntax]
   - module: CustomFeedSVNLog
     config:
       target: http://redmine.rubyforge.org/svn
       fetch_items: 2 # If not specified, 30
 
 
+SubscriptionURI
+---------------
+[Path]
+ /plugins/subscription/uri.rb
+
+[Input]
+ None
+
+[Output]
+ HTML
+
+[Description]
+ Open http or ftp URL to file object.
+
+[Syntax]
+  - module: CustomFeedURI
+    config:
+      url:
+        - URL
+        - URL ...
+
+
+ExtractLink
+-----------
+[Path]
+ /plugins/extract/link.rb
+
+[Input]
+ HTML
+
+[Output]
+ An array of links.
+
+[Description]
+ Extract a link in HTML.
+
+[Syntax]
+  - module: FilterLink
+
+
+FilterImageLink
+---------------
+[Path]
+ /plugins/filter/image_link.rb
+
+[Input]
+ An array of links.
+
+[Output]
+ An array of links.
+
+[Description]
+ Extract image's link from HTML.
+
+[Syntax]
+  - module: FilterImageLink
+
+
+StoreLink
+---------
+[Path]
+ /plugins/store/link.rb
+
+[Input]
+ An array of links.
+
+[Output]
+ An array of links.
+
+[Abstract]
+ Save a permanent link.
+ The duplicate permalink will be discarded.
+ This is a HTML version for StorePermalink.
+
+[Syntax]
+  - module: StoreLink
+    config:
+      db: DB_NAME
+
+
+StoreTarget
+-----------
+[Path]
+ /plugins/store/target.rb
+
+[Input]
+ An array of links.
+
+[Output]
+ An array of links.
+
+[Description]
+ Store target locally by a link in HTML.
+ This emulate "Right click to save".
+
+[Syntax]
+  - module: StoreTarget
+    config:
+      path: SAVE_TO_PATH
+      interval: INTERVAL_FOR_DOWNLOAD (in seconds.)

data/doc/PLUGINS.ja

@@ -7,6 +7,12 @@ SubscriptionFeed
 [パス]
  /plugins/subscription/feed.rb
 
+[入力]
+ 無し
+
+[出力]
+ フィード
+
 [概要]
  フィードを購読する
 
@@ -23,11 +29,17 @@ FilterReverse
 [パス]
  /plugins/filter/reverse.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  日付の昇順にソートする
 
 [レシピ記法]
-  - module: FilterImage
+  - module: FilterReverse
 
 
 FilterIgnore
@@ -35,6 +47,12 @@ FilterIgnore
 [パス]
  /plugins/filter/ignore.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  NG ワードを除外する
 
@@ -46,17 +64,23 @@ FilterIgnore
         - 無視キーワード ...
 
 
-FilterImage
-------------
+FilterImageSource
+-----------------
 [パス]
- /plugins/filter/image.rb
+ /plugins/filter/image_source.rb
+
+[入力]
+ フィード
+
+[出力]
+ フィード
 
 [概要]
- パーマリンクを本文中の画像のリンクに書き換える
- 画像のリンクが無い場合は nil にする
+ パーマリンクを本文中の画像のソースリンクに書き換える
+ 画像のソースリンクが無い場合は nil にする
 
 [レシピ記法]
-  - module: FilterImage
+  - module: FilterImageSource
 
 
 FilterTumblrResize
@@ -64,6 +88,12 @@ FilterTumblrResize
 [パス]
  /plugins/filter/tumblr_resize.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  パーマリンクを Tumblr の最大サイズ
  (High Res) に書き換える
@@ -80,14 +110,20 @@ StorePermalink
 [パス]
  /plugins/store/permalink.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  パーマリンクを保存する
  重複したパーマリンクは破棄する
 
 [レシピ記法]
-  - module: StoreBookmark
+  - module: StorePermalink
     config:
-      db: ブックマークを保存する SQLite3 DB 名
+      db: パーマリンクを保存する SQLite3 DB 名
 
 
 StoreFullText
@@ -95,6 +131,12 @@ StoreFullText
 [パス]
  /plugins/store/full_text.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  フィード全文を DB に保存する
 
@@ -112,6 +154,12 @@ StoreTargetLink
 [パス]
  /plugins/store/target_link.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  リンク先のコンテンツをローカルに保存する
 
@@ -127,6 +175,12 @@ PublishConsole
 [パス]
  /plugins/publish/console.rb
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [概要]
  パイプラインをコンソールに出力する
 
@@ -142,6 +196,12 @@ PublishHatenaBookmark
 [概要]
  はてなブックマークをする
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [説明]
  はてなブックマーク API への投稿用 XML を生成し
 送信する
@@ -162,6 +222,12 @@ PublishGoogleCalendar
 [概要]
  Google Calendar に予定を登録する
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [説明]
  item.title を Google カレンダーに登録する
 
@@ -181,6 +247,12 @@ NotifyIkachan
 [概要]
  ikachan へメッセージを送信する
 
+[入力]
+ フィード
+
+[出力]
+ フィード
+
 [説明]
  ikachan へ HTTP 経由で POST する
  ikachan とは: http://blog.yappo.jp/yappo/archives/000760.html
@@ -198,7 +270,13 @@ NotifyIkachan
 CustomFeedSVNLog
 ----------------
 [パス]
- /plugins/custom/feed_svn_log.rb
+ /plugins/custom_feed/svn_log.rb
+
+[入力]
+ 無し
+
+[出力]
+ フィード
 
 [概要]
  SVN から新しいリビジョン情報を取得する
@@ -214,3 +292,102 @@ CustomFeedSVNLog
       fetch_items: 2 # 指定されない場合は 30
 
 
+SubscriptionURI
+---------------
+[パス]
+ /plugins/subscription/uri.rb
+
+[入力]
+ 無し
+
+[出力]
+ HTML
+
+[概要]
+ http/ftp の URL をファイルオブジェクトとして開く
+
+[レシピ記法]
+  - module: CustomFeedURI
+    config:
+      url:
+        - URL
+        - URL ...
+
+
+ExtractLink
+-----------
+[パス]
+ /plugins/extract/link.rb
+
+[入力]
+ HTML
+
+[出力]
+ An array of links.
+
+[概要]
+ HTML の a リンクのみを抽出する
+
+[レシピ記法]
+  - module: FilterLink
+
+
+FilterImageLink
+---------------
+[パス]
+ /plugins/filter/image_link.rb
+
+[入力]
+ An array of links.
+
+[出力]
+ An array of links.
+
+[概要]
+ 画像ファイルのリンクのみを抽出する
+
+[レシピ記法]
+  - module: FilterImageLink
+
+
+StoreLink
+---------
+[パス]
+ /plugins/store/link.rb
+
+[入力]
+ An array of links.
+
+[出力]
+ An array of links.
+
+[概要]
+ パーマリンクを保存する
+ 重複したパーマリンクは破棄する
+ これは StorePermalink の HTML 版である
+
+[レシピ記法]
+  - module: StoreLink
+    config:
+      db: パーマリンクを保存する SQLite3 DB 名
+
+
+StoreTarget
+-----------
+[パス]
+ /plugins/store/target.rb
+
+[入力]
+ An array of links.
+
+[出力]
+ An array of links.
+
+[概要]
+ HTML の a リンク先のコンテンツをローカルに保存する
+
+[レシピ記法]
+  - module: StoreTarget
+    config:
+      path: 保存先のフォルダ
+      interval: 保存する間隔 (秒)