設置方法

dream.phpを既に使っている場合は、DreamViewerだけのダウンロードで構いません。

1. dream.php と DreamViewerの最新バージョンをダウンロードして、それぞれZIPファイルを解凍してください。
2. 解凍したdream.phpの中の dreamフォルダ を、お好きな階層にアップロードしてください。
   
3. 「dreamフォルダをアップロードした階層/setup.php」にアクセスして、設定ファイルのdream_fix.iniを作成してください。

   https://your-account.domain.com/dream/setup.php

   
4. dreamフォルダと同じ階層にviewerフォルダをアップロードしてください。
   
   viewer同梱のconfig.phpでdream.phpの読み込みパスの設定を変更することで、お好きな階層で使うこともできます。

利用方法

1. 作品本文をtxtファイルで作成保存するか、HTMLでページを作成してhtmlファイルとして、それぞれ「（半角英数 ・アンダースコア・ハイフン）.txt」か「（半角英数・アンダースコア・ハイフン）.html」or「（半角英数・アンダースコア・ハイフン）.htm」のファイル名で保存してください。
   ファイル内で以下の独自コードが使えます。

   {{NAME項目番号}}

   該当の項目番号の登録名と置き換わります

   {{NAME項目番号|デフォルト名}}

   該当の項目番号の登録と置き換わり、かつデフォルト名が記述のものになります
   ※ver.2.0.0からファイル単位でのデフォルト名設定もできるようになりました

   {{NAME項目番号:カスタムタイプ}}

   該当の項目番号の登録内容をカスタム表示できます[カスタム表示タイプ詳細]

   全て半角です。半角全角大文字小文字が合致していなかったり、スペースや改行などを含んでしまうと置き換え対象として認識できません。同梱のsample.htmlおよびsample.txtを参考にしてください。
   
   viewer同梱のconfig.phpで、独自タグ文法の設定を変更することもできます。

   #name:0# @1@ [name]苗字[/name] ≪花子≫

2. 作成したファイルは必ずUTF-8の文字コードで保存してください。
   
   保存時の文字コードについてはお使いのエディタの設定を確認してください
3. 完成したファイルを、viewerフォルダ内のdirフォルダにアップロードしてください。
   viewer同梱のconfig.phpで、フォルダ名の設定を変更することもできます。
   
4. 「あなたのサイトのviewerフォルダまでのアドレス/viewer/index.php?file=アップロードしたファイル名」 にアクセスすると変換がされて表示されます。（多くのサーバーは、index.phpを省略することもできます）

   https://your-acount.domain.com/viewer/?file=new.txt

   
5. 任意のファイルを作って、先ほどのアドレスにリンクをはってサイトを作成してください。

   <a href="./viewer/?file=new.txt">作品タイトル</a>

   もしくは、ナンバリングかファイル名の一覧でもよければ、Viewer内のhtmlファイルかスキンファイル内で特定ディレクトリ内のファイル一覧を出力できるので、Viewer内で作品リンクページを作成することもできます。

デフォルト名変更とカスタム表示

順序不順で、両方設定もできます。

{{NAME項目番号:カスタムタイプ|デフォルト名}}
{{NAME項目番号|デフォルト名:カスタムタイプ}}

デフォルト名の変更

項目番号（もしくは設定したタグ名）の後に、半角縦線（|）、続けてデフォルト名を記述してください。

viewer同梱のconfig.phpで、独自タグ文法の設定の「独自タグ上書きデフォルト名用区切」を変更することで半角縦線から別の記号や文字列に変えることもできます。

カスタム表示

項目番号（もしくは設定したタグ名）の後に、半角コロン（:）、続けて使いたいカスタム表示タイプを記述してください。

どもり・区切・途切れに使われる区切り記号の変更に未対応です。全部「…」になります。

viewer同梱のconfig.phpで、独自タグ文法の設定の「独自タグカスタムタイプ用区切」を変更することで半角コロンから別の記号や文字列に変えることもできます。

txtファイル

拡張子が.txtのファイルが許可されます。

改行が<br>に置き換わります。

スキン内で<title>や<h1>の内容として使う用に、ファイルの一行目（空行を取り除いたうえで）だけ特別に取得されます。
一行目に作品やページのタイトル（大見出し）を記述して、二行目以降から本文を書いてください。
同梱のsample.txtを参照してください。

独自記法とHTMLタグ

一部の独自記法に対応しています。

ルビタグ

ルビタグは、以下の記法に倣ったものがどれでも使えます。同じファイル内で混在しても変換されます。
｜漢字《ルビ》に関して、最初の｜は全角でも半角でもいいですが、無しにすることはできません。

ルビ記述サンプル

｜漢字《ルビ》
[[rb:漢字 > ルビ]]
[#ruby=漢字_ルビ#]
[漢字"ルビ"]
[RB:漢字,ルビ]
[R:漢字:ルビ]
{rb}漢字|ルビ{/rb}

ルビ出力

<ruby><span aria-hidden="true">漢字</span><rt>ルビ</rt></ruby>

現状だと、読み上げ機能などを使った際、漢字部分（親文字）を飛ばしてルビだけを読む記述で出力されます。
親文字だけ読んで欲しい、親文字もルビも読んで欲しいというケースであれば、独自記法を使わず自分でHTMLタグを書いてください。※将来的に機能改善検討中

章タイトル

小見出しをつけられます。ピクシブの章タイトルの記法に倣ってます。

章タイトル記述サンプル

[caption: 章タイトル]

章タイトル出力

<h2>章タイトル</h2>

<h2>よりさらにlevelの低い見出しが必要な場合は、自分でHTMLタグを書いてください。

ページ分割

同ファイル内の好きな部分でページ分割ができます。ピクシブ、Wordpress、くるっぷに倣ったタグどれでも使えます。同じファイル内で混在しても変換されます。

1ページ目
[newpage]
2ページ目
<!--nextpage-->
3ページ目
[PG]
4ページ目

同ファイル内のページ分割はtabとJavaScriptとCSSで実現しています。無効な環境だと全てが表示され、ページ内リンクとして機能します。

HTMLタグ

独自記法に頼らずとも、書いたままHTMLタグが有効です。

<strong>娘</strong>は、<span style="color:red">赤</span>い絵具で、
<div style="border:1px solid">白い<ruby>蝋燭<rt>ろうそく</rt></ruby>に、魚や、貝や、
また海草のようなものを産れつき誰にも習ったのでないが上手に描きました。</div>

ページ分割を利用する場合、分割ごとに<div>が追加されるので、タグの入れ子が崩れないようにしてください。

NGな記述

分割独自タグをまたいだ要素

<b>太字にしたい文章
[newpage]
太字にしたい文章</b>

OKな記述

分割独自タグの前に閉じタグ、分割独自タグの後に開始タグ

<b>太字にしたい文章</b>
[newpage]
<b>太字にしたい文章</b>

htmlファイル

拡張子が.htmか.htmlのファイルが許可されます。

文字コードはUTF-8です。他の文字コードのファイルだと文字化けの可能性があります。

画像やCSSなどのファイルを読み込ませる場合は、viewer/index.phpからの相対パス、もしくはルートディレクトリからのパスを使ってください。

htmlファイル内では、{{title}}{{content}}を除いたスキン用の独自タグが有効です。

「index.html」はダミーファイルとして存在する可能性があるため、Not Found扱いになりますので、index.html以外のファイル名にしてください。

dirフォルダ

ファイル保存フォルダ内はさらに階層を深くしても構いません。その場合は、dirフォルダから先の階層パスを、fileパラメーターにつけてください。

../（..\）を含んだ指定はできません。

ファイル保存フォルダ内のフォルダ名は適応スキン名と相互関係になります。詳しくは、スキンについての項目を参照してください。

dream.phpの読み込み

階層を変更した場合は書き換えてください。（「viewerのディレクトリ」というか、viewer/index.phpのファイルからの相対パスです）

//▼viewerのディレクトリからのdream.phpの相対パス
const CORE = '../dream/dream.php';

フォルダ名

フォルダ名は自由に変えられます。必ず末尾にスラッシュ入れてください。
.htaccessが使えない環境の場合は、不正アクセス防止のため憶測され辛い名前への変更をおすすめします。

//▼ファイル保存フォルダ
const DIR = 'dir/';

//▼スキン保存フォルダ
const SKIN = 'skin/';

//▼ファイル保存フォルダ
const DIR = 'dir/text/';

//▼スキン保存フォルダ
const SKIN = '../mySkin/';

変換名用独自タグ

変換名表示のために使います。文法は以下の通りです。

接頭辞 + 項目番号orタグ名 + 接頭辞
接頭辞 + 項目番号orタグ名 + デフォルト名用区切 + (デフォルト名) + 接尾辞
接頭辞 + 項目番号orタグ名 + カスタム用区切 + (カスタムタイプ) + 接尾辞

接頭辞 + 項目番号orタグ名 + デフォルト名用区切 + (デフォルト名) + カスタム用区切 + (カスタムタイプ) + 接尾辞
接頭辞 + 項目番号orタグ名 + カスタム用区切 + (カスタムタイプ) + デフォルト名用区切 + (デフォルト名) + 接尾辞

想定外の文章中で合致しないような組み合わせにしてください。

テキストファイル出力を利用する場合は、スキンで使われる独自タグやルビタグなどの独自記法も導入しているので、そちらと競合しないよう注意してください。

HTMLファイル出力を利用する場合は特に気を付けてください。
現在のバージョンは、ファイル内の文字列全てを対象にして置き換わるので、ページ内のHTMLタグ、JavaScriptやCSSなどのコード、読み込むファイル名やリンク先のアドレスなどと予期せず一致してしまうと、ページ内容が破綻する可能性があります。
使う機会の少ない全角記号を使ったり、「ユーザー定義独自タグ名」で他で出現しなさそうなタグ名を考えるといいかもしれないです。

仕様

• いずれも1文字以上なら文字数は問わない
• 接頭辞と接尾辞は同じ文字でもOK
  例; ##0##
• いずれも半角全角英数漢ひらカナ記号のどれを使っても、混在してもOK。
  例; [Start変]0[/換enD]

以下の設定はNGです。

• カスタムタイプ用区切もしくはデフォルト名用区切が、接頭辞もしくは接尾辞と同じ
  ダメな例; ≪NAME0:カスタム≪デフォルト名】
• カスタムタイプ用区切とデフォルト名用区切が同じ
  ダメな例; {{NAME0||カスタム||デフォルト名}}
• 4項目いずれかの設定がされていない
  ダメな例; const TAG_PREFIX = '';
• 接頭辞の最後の文字や接尾辞の最初の文字が半角数字は、項目番号との判別でバグる可能性があるので非推奨（ユーザー定義独自タグ名を数字以外設定するならOK）
  ダメかもしれない例; +name101end+

//▼独自タグ接頭辞
const TAG_PREFIX = '{{NAME';

//▼独自タグ接尾辞
const TAG_SUFFIX = '}}';

//▼独自タグカスタムタイプ用区切
const TAG_DELIMITER1 = ':';

//▼独自タグ上書きデフォルト名用区切
const TAG_DELIMITER2 = '|';

項目番号以外の任意の文字列をタグ名として使うこともできます。

[]の中に、項目番号0から順に対応させたいタグ名を、一つずつ引用符で囲って、半角カンマ区切りで羅列してください。HTMLファイルでも使う場合は、HTMLファイル内で使える独自タグと同じものはつけないでください。

//▼ユーザー定義独自タグ名（配列で）
const TAG_NAMES = []

• 独自タグ名の設定数とdream.phpで設定した項目数は必ず同じでなければならない
• タグ名は重複しない
• タグ名に接頭辞・接尾辞・区切に使われる文字は含めない

//▼ユーザー定義独自タグ名（配列で）
const TAG_NAMES = ['-myouji-','名前','みょうじ','はなこ','血液型']

//設定不備例: 設定数不足・項目0と項目2が「MYOUJI」で重複

//▼ユーザー定義独自タグ名（配列で）
const TAG_NAMES = ['MYOUJI','NAME','MYOUJI']

ページ一律デフォルト名設定

defName : 項目0のデフォ名,項目1のデフォ名,項目2のデフォ名...

データ名「defName」のデータ内容に、そのファイル内で使いたいデフォルト名を、半角カンマ（,）区切りで項目番号順に羅列してください。

ワンクッション設定

設定すると、アクセス時にモーダルで注意書きがポップアップします。

warning : yes

データ名「warning」のデータ内容に、以下の四種類のキーワードのどれかを書き込んでください。それぞれにちなんだアイコンが使われたりします。

キーワードに続けて、半角カンマ + 独自の注意書きを追加すると、独自の注意書きがモーダル内に出力されます。注意の詳しい内容があれば書いてください。

warning : netabare,映画版の設定を含みます

ポップアップせず、文字として出せればいいのであれば、スキンの独自タグを{{warning:noModal}}に書き換えてください。

モーダルポップアップはdialogとJavaScriptによって実現しています。それらに対応していない環境でのアクセス時は、{{warning:noModal}}と同じ挙動になります。

パスワード設定

設定すると、閲覧にパスワード入力が必要になります。

アクセスまでに1手多くかかるだけの簡易的なものです。セキュリティ対策はないので、重要な情報を隠したり重要な内容をパスワードとして使うことは絶対にしないでください。

password : 12345

データ名「password」のデータ内容に、お好きなパスワードを書き込んでください。
txtファイルであれば{{content}}内容として、HTMLファイルであれば別途パスワード入力フォームのページが出るようになります。

パスワードは、基本的にはどんな文字列を何文字でも使えます。サーバーによっては勝手に送信情報の文字コードを変えられて、読み取れないことがあります。うまくいかなかったら半角英数のパスワードで試してください。

パスワードに続けて、半角カンマ + パスワード入力フォーム傍に表示される文章を追加すると、それがパスワード入力フォーム前に出力されます。

password : 12345 , 「12345」と入力してください

予約公開

作品のファイル名のはじめの12文字を、それぞれ半角数字二桁表記の「年月日時分」にすると、そのファイル名にした日時より前は一覧および前後リンクに表示されません。時間は24時間単位です。

202312240000.txt

2023年12月24日00時00分以降公開される

202401012001-happy.html

2024年01月01日20時01分以降公開される

20240809071500001.txt

2024年08月09日07時15分以降公開される

日時は日本標準時間です。

特筆事項

スキンファイルの構成

1つのhtmlファイルで完成します。添付しているスキンファイルは画像未使用で全部内部にCSSを書いてますが、外部CSSを使ったり画像を使っても構いません。

default.html

スキン保存フォルダ内のdefault.htmlは必須ファイルです。スキンを追加したり、同梱のdefault.htmlを自由に編集して構いませんが、必ず必要なので削除しないでください。

viewer.cssとviewer.js

ページ分割、モーダルなど、機能性に関わるファイルなので、それらの機能が必要なのであれば必ず二つのファイルを読み込む記述が必要です。viewer.jsは</body>直前で読み込ませてください。

スキンファイル内で置き換わる独自タグ

スキン用の独自タグは、開始半角波括弧2つ + タグ名 + 終了波括弧2つが構文です。途中に不要なスペースや改行を含んだり大文字小文字半角全角が異なると認識されません。
タグによっては、タグ名に続けて、半角コロン区切でパラメーターを送ることもできます。 （例; {{nameForm:0,1}}）

進む戻るリンク、フォルダ内ファイル一覧リンクは、現在ファイル名の昇順ソート（0→9、a→z）でのみの出力です。他のソートもできるよう改良予定です。

予約：{{count}}

内容の文字数（真の文字数調べるの大変そうなので後回し

※スキンファイル内で変換名用独自タグやテキストファイル用独自記法（ルビタグなど）を書いても置き換えされません

前後リンクや一覧は現在ファイルの名前の昇順ソート限定です。「index.html」はダミーファイルとして存在する可能性からNot Found扱いになるので、一覧からも除外されます。

複数のスキンの使い分け

スキンは複数を使い分けることができます。

ファイル保存フォルダ内に、適応させたいスキンと同名のフォルダを作って、スキンを適応させたいファイルはそのフォルダ内にアップロードしてください。

階層が深い場合は、より深い（ファイルに近い）フォルダ名のスキンが優先されます。

もしくは、アドレスに &skin=使いたいスキンファイル名 のパラメーターを追加するとそのスキンが使われます。別のスキンが適応されるフォルダ内のファイルであっても、パラメーターでの指定が優先されます。（パラメーターのスキンファイル名に.htmlはつけません）

合致するスキンがなければdefault.htmlが使われます。

スキンを新たに編集、作成する場合は以下三点ご注意ください。

• UTF-8で作成
• 拡張子は.html
• 画像やCSSなど外部ファイルを参照するときは、スキンファイルからの相対パスではなく、viewer/index.phpからの相対パス、もしくは{{skin_folder}}を使ってスキンフォルダからの相対パス、もしくはルートディレクトリからのパスを使う
  例; viewer/skin/skin1.html のファイル内で viewer/img.jpg を表示する→ <img src="./img.jpg" alt=">
  例; viewer/skin/skin2.html のファイル内で viewer/skin/skin2.css を使う→ <link href="{{skin_folder}}skin2.css">

アクセス制限

同梱ファイルの.htaccessで設定しているものです。

同梱の.htaccessをアップロードできないと、作品ファイルに直接アクセスされて内容が見られてしまう可能性があります。個人情報のように見られてヤバいものではないですが、パスワード制にしていてもファイルのほうを直接見られるといったように不正な閲覧ができる状態なので、以下を参照して対策をお勧めします。

#アクセス禁止
Require all denied

Deny from all

• 上記の内容をUTF-8で「htaccess.txt」として作成、ファイル保存フォルダ直下にアップロードして、ファイルマネージャーやFTPでファイル名を「.htaccess」に書き変え、サーバーに応じてパーミッションを適切に変更する
• お使いのサーバーのファイルマネージャーや専用の管理画面から、.htaccessの作成編集やアクセス制限の設定ができるのであればそれらを利用して、ファイル保存フォルダのアクセスを禁止
• ファイル保存フォルダの名前を憶測しづらいものに変えて、config.phpの設定を編集する ※フォルダの名前がばれたらアクセスはされてしまいます

アクセスアドレス変更

デフォルトでは、index.php?file=filenameとパラメーターつき丸出しのアドレスですが、.htaccessでパラメータを引き継いでリダイレクトさせることで、「https://sample.com/viewer/filename」みたいなアドレスでアクセスできるようにすることもできます。
※現在自動出力されるリンクはパラメーターで出ますので、前後リンクや一覧リンクは使わず手動で書く必要があります。
将来的には対応できるようになる予定です。

• 【参考】htaccess リダイレクト getパラメータ - Google検索