TSSPageGeneratorの設定ファイル

設定ファイルはスクリプト・ファイルと同じフォルダーにある、スクリプトと同じ名前の JSON ファイルです。.

設定ファイルの変数:

変数 'Foo' は、クラス内では 'FFoo' ('F'が前にくる)です。だから、 '$this->GetFoo()' は、 '$this->FFoo'の値を返します。これは、設定ファイル内では、'Foo'　となります。このルールは、他のクラスでも、同じです。

ContentsFolder

json ファイル、html ファイル、及び php ファイルを収めたファイルです。

L10nFolder

ローカリゼーションてんファイル (訳ファイル、及び訳した html ファイル) を　'ContentsFolder' フォルダーでない所におく場合に設置します。

HtmlFileExtension

html ファイルのデフォルトのファイル拡張子。

JsonFileExtension

json ファイルのデフォルトのファイル拡張子。

PhpFileExtension

php ファイルのデフォルトのファイル拡張子。

UseHtml4ForInput

もし true　なら, header contents, main contents, aside contents, 及び footer contents は 指定された　html　ファイルの (それぞれのタグでなく)　'body' タグで囲まれた部分とみなされます。

PreamblePhpFile

このファイルは、ページ作成前に実行されますので、ユーザー・チェックなどに使用します。L10n モジュールは、これ以前に設定されますので、すでに使用できます。

HeadHtmlFile

この　html　ファイルの　Head 部分をページの headに使用します。

HeadPhpFile

この　php ファイルで作成されたコンテンツをページの head　に取り入れます。

PageTitle

設定されていれば、ページ・タイトルとして使用します。

HeadCssUrl

string (一個のCSSファイルのurl) または stringのarray (複数のcss ファイルの　url)

CssUrlPrefix

値が true (標準)なら、ContentsFolder の価をとります。これが empty でないなら、css （絶対 url　でないなら）は CssUrlPrefix からの　url　となります。

BodyOptions

もし empty でないなら、タグ　'body' のオプションとして使用されます。

Title

コンテンツ・タイトルで 'header'　の初めに書き込まれます。もしtrueなら、PageTitleを使用します。

TitleEnclosure

'Title'を囲むタグです。cssでフォーマットするのに使います。

TitleOptions

もし emptyでないなら,　タグ　'TitleEnclosure'　のオプションとして使用します。

HeaderContentsOptions

もし empty 出ないなら、'header' タグのオプションに使用します。

HeaderContentsHtmlFile

このファイルの'header' で囲まれた部分を'header'のコンテンツとして使用します。

HeaderContentsPhpFile

この php ファイルで生成されたものを 'header'　部分に取り入れます。

L10nSelectionContentsOptions

値が empty　でないなら、'L10nSelection'のタグ 'nav' のオプションとなります。

L10nSelectionOnTop

もし trueなら、'L10nSelection' メニューを 'header'以前に作成します。

L10nLangOptionName

これがemptyでないなら、言語セレクター'L10nSelectionContents' メニュー作成をします。これの値は言語コードを次のスクリプトのURLに GET モードで渡します。もし emptyなら、 'L10nSelectionContents' メニューは作成されません。

L10nMenuToagle

この値が trueで,言語セレクターのメニューファイルにtoagleのパラメーターが指定されていれば、メニュー toagle （隠す／表す）コードを作成します。

L10nMenuType

言語セレクター・メニューのタイプで、'ul', 'ol', 'div', か 'span'です。

L10nMenuId

'L10nMenuType'に指定されたタグのId で、'L10nMenuToagle' が　'true'の場合に必要です。またcssでの言語セレクターのフォーマットにも使用できます。

L10nMenuOptions

値が empty出ないなら、'L10nMenuType'に指定されたタグのオプションとなります。

L10nCurrentLang

ローカリゼーション・モジュール　(L10n)　と言語セレクター・メニューに用いられる言語・コード　（Id）です。この価は、URL (GET method)の オプションの価（L10nLangOptionNameで指定された名前の) 殻もおT目られます。それがない場合は、設定ファイルの（L10nLangOptionNameで指定した名前の）関数の価になります。もし、これもない場合はユーザーの使用しているブラウザーの言語設置から判定します。普通は設定しません。

L10nMenuFile

言語セレクター・メニューのJSON ファイルです。

L10nMenuPhpFile

この php ファイルで作成されたコンテンツを言語セレクターの 'nav' タグ内に取り込みます。

NavegationContentsOptions

もし emptyでないなら、ナビゲーション・メニューのタグ 'nav' のオプションとなります。

MenuToagle

この値が trueで,メニューファイルにtoagleのパラメーターが指定されていれば、メニュー toagle （隠す／表す）コードを作成します。

MenuType

ナビゲーション・メニューのタイプで、'ul', 'ol', 'div', か 'span'です。

MenuId

'MenuType'に指定されたタグのId で、'MenuToagle' が　'true'の場合に必要です。またcssでのナビゲーション・メニューのフォーマットにも使用できます。

MenuOptions

値が empty出ないなら、'MenuType'に指定されたタグのオプションとなります。

SubMenuOptions

値が empty出ないなら、メニューのサブ・メニューの'MenuType'に指定されたタグのオプションとなります。

MenuDisabledItem

アイテムか、アイテムのリスト (サブメニューの場合)で、これに指定されたアイテムを、ナビゲーション・メニューで無効にします。

MenuFile

メニューのJSON ファイルです。

MenuPhpFile

この php ファイルで作成されたコンテンツをナビゲーション・メニューの 'nav' タグ内に取り込みます。

MainContentsOptions

この値が emptyでないなら、タグ 'main' のオプションに使用します。

MainContentsHtmlFile

この html ファイルの、タグ 'main' で囲まれた部分を 'MainContents' の部分に使用します。

MainContentsPhpFile

この php ファイルで作成されたコンテンツを 'MainContents' に加えます。

ASideBeforeMain

もし trueなら 'ASideContents' を 'MainContents'の前に置きます。

ASideContentsOptions

もし emptyでないなら、タグ 'aside' のオプションとなります。

ASideContentsHtmlFile

この html ファイルの、（一番目の）タグ 'aside' で囲まれた部分を 'AsideContents' の部分に使用します。

ASideContentsPhpFile

この php ファイルで作成されたコンテンツを 'AsideContents' に加えます。

BottomNavegationContentsOptions

もし emptyでないなら、ボトム・メニューのタグ 'nav' のオプションとなります。

BottomMenuToagle

この値が trueで,メニューファイルにtoagleのパラメーターが指定されていれば、ボトム・メニュー toagle （隠す／表す）コードを作成します。

BottomMenuType

ボトム・メニューのタイプで、'ul', 'ol', 'div', か 'span'です。

BottomMenuId

'BottomMenuType'に指定されたタグのId で、'BottomMenuToagle' が　'true'の場合に必要です。またcssでのボトム・メニューのフォーマットにも使用できます。

BottomMenuOptions

値が empty出ないなら、'BottomMenuType'に指定されたタグのオプションとなります。

BottomSubMenuOptions

値が empty出ないなら、ボトム・メニューのサブ・メニューの'BottomMenuType'に指定されたタグのオプションとなります。

BottomMenuDisabledItem

アイテムか、アイテムのリスト (サブメニューの場合)で、これに指定されたアイテムを、ボトム・メニューで無効にします。

BottomMenuFile

ボトム・メニューのJSON ファイルです。

BottomMenuPhpFile

この php ファイルで作成されたコンテンツをボトム・メニューの 'nav' タグ内に取り込みます。

FooterContentsOptions

もし emptyでないなら、タグ 'footer' のオプションとなります。

FooterContentsHtmlFile

この html ファイルの、（一番目の）タグ 'footer' で囲まれた部分を 'FooterContents' の部分に使用します。

FooterContentsPhpFile

この php ファイルで作成されたコンテンツを 'FooterContents' に加えます。

L10nFile

メインのローカリゼーションのファイル、またはファイルリストです。これに指定されたファイルの次に、スクリプトと同じ名前の json ファイルを求めて読み込みます。もし、執拗なら、php ファイル内で使用できる、このローカリゼーション・クラスは $this->FL10n です。

TSSCKPageGeneratorクラスの参考

• パラメーターは、大文字と小文字をを区別しません。 (php　では、関数名は大文字と小文字の区別をします）。また、全部のパラメーター（リストアップされた関数）をarray としてえるには、$this->GetParam()を使用してください。phpで　array　のアイテムをアクセスするキーは、大文字と小文字を区別します。
• ファイルから読み込まれた（あるいはarrayで提供された）パラメーターで、ここにリストされた関数でないものは'Options' arrray に保管されますので、 $this->GetOption()でその値を得ることができます。オプション名は、大文字と小文字を区別しません。これらの値全部を arrayとしてえるには、$this->GetOptions()を使用してください。phpでは、arrayのキーは大文字と小文字を区別します。
• 提供された php ファイルの実行は TSSCKPageGenerator　のメンバー関数内でおこなはれますので、このクラスの全部の関数及び変数鵜をアクセスできます。(注意しながら用いてください).
• 関数 str() は FL10n->str() を呼び出して string の訳を行います。また、訳された html ファイルの保管場所は、ContentsFolder　内の <lang code> サブフォルダーとなります。例えば ContentsFolder が 'main' で　MainContents　の html ファイルが 'contents.html'の場合、言語オプションに 'ja'を使用すると、'contents.html' は'main/ja'内にあると判断します。それがない場合は 'main' 内に求めます。訳ファイルの場合は　L10nFolder (この値がtrueなら、ContentsFolderとなります)　内を同じルールで探索します　例えば 'L10nFolder' が 'main', 'L10nFile' が 'translation.json'で言語コードが 'ja' なら、'translation.json' ファイルを 'main/ja'　内に求めます。もしそこにない場合は、 'main'　フォルダー内を探索します。'L10nFile'で指定されたファイルを読み込んだ後、スクリプトファイルと同じ名前の json ファイルを読み込みます (探索フォルダーは'L10nFile'のファイルと同じです)。 PHP ファイルの場合は 関数鵜'$this->str()' を用いて訳しているものと前提して 'ContentsFolder'内に求めます。
• もし、 php ファイル内で関数を定義した場謂は、このクラスのメンバー関数とならないので、その関数鵜から直接クラスのメンバー関数鵜やメンバー変数をアクセスできません。ですから、もし 'L10n' モジュールなどが必要でしたら、$this->FL10n を定義した関数へ渡してください。
• 多言語システムで、言語セレクターを用いずに、言語を固定するには、L10nLangOptionName を emptyにして、L10nCurrentLang で選んだ言語のコードを指定してください。

他のモジュール

TSSAlbum

変数

Folder

アルバムのファイルのあるフォルダーです。 'Generate()' は、このフォルダーとそのサブフォルダーを探索します。

Options

値が emptyでなければ、アルバム・タイトルのタグ　'<h3>'のオプションとなります。

AlbumEnclosureTag

値が emptyでないなら、アルバム　と　サブ・アルバム　（サブ・フォルダー内のもの）を包むタグとなります。

AlbumOptions

AlbumEnclosureTag に指定されているアルバムを包むタグのオプションです。

SubAlbumOptions

AlbumEnclosureTag に指定されているサブ・アルバム（サブフォルダー内の部分）を包むタグのオプションです。

ImageExtensions

画像ファイルの拡張子のリストです。リスト以外の拡張子のフィルはスキップされます。

MovieExtensions

ムービーファイルの拡張子のリストです。リスト以外の拡張子のフィルはスキップされます。

ImageOptions

値が emptyでなければ、画像の　thumbnailのタグ '<img>' のオプションとして用います。

MovieOptions

値が emptyでなければ、ムービーの　thumbnailのタグ '<img>' のオプションとして用います。

ImageUrlOptions

値が emptyでなければ、画像の　URL　のタグ '<a>' のオプションとして用います。

MovieUrlOptions

値が emptyでなければ、ムービーの　URL　のタグ '<a>' のオプションとして用います。

MovieAfterThumbOptions

ムービーの thumbnailの　タグ　'img'の次に置かれるタブ　'span' のオプションです。この　'span'　タグは css でムービーの thumbnail をフォーマット (例えば、'play' アイコンをかぶせる）するためのもので、内部は空です。

ThumbFolder

画像／ムービーの thumbnail をアルバムフォルダー外に設定するためのものです。もし false　なら、アルバムと同じフォルダーになります。

ThumbSubFolder

thumbnailsを置くサブフォルダー名です。 ThumbFolder が falseなら、設定してください。

ThumbPrefix

Thumbnail ファイル名の prefix で、画像／ムービーファイルと区別をするのに用います。

ThumbPostfix

Thumbnail ファイル名の postfix で、画像／ムービーファイルと区別をするのに用います。

ThumbDisplayWidth

Thumbnail ファイルの幅です。thumbnailsのないファイルがあるなら、設定してください。

L10n

ローカリゼーション・モジュールで、stringを訳をする関数 'str()'　があると前提されます。もし nullでなければ、アルバム・タイトルを訳します。

TSSCsvListReader

このクラスは csv ファイルからリストを作成する 'Read()' (及び array　から作成する 'Print()')を協定します。

変数

FileName

CSV ファイル・ネームです。

Separator

CSV ファイルのカラムの セパレーターです。普通は colon か semi-colon　です。

Enclosure

CSV ファイルのカラムを包むものです。普通は、二重引用符です。

-->

TrimmingChars

これで指定されたcharsがカラムのまえにきているものはスキップされます。普通は、emptyです。

OnlyEmptyItemsIsEmptyRow

カラムが全部からであれば、空の行と判定します (空の行は、表のセパレーターです)

Type

リストのタイプで 'ul', 'ol', か 'dl'　です。

HeadFragmentEnclosureTag

最初の部分（CSV　ファイルの最初のカラム）を包むタグです。普通は、 'span'をおすすめです。

HeadFragmentOptions

もし emptyでないなら、'HeadFragmentEnclosureTag'に指定されたタグ（'dl'　タイプなら　'dt'）のオプションとなります。.

TailFragmentEnclosureTag

タイル（最初の部分　ー　CSV　ファイルの最初のカラムーを除いたもの）を包むタグです。普通は、 'span'をおすすめです。

TailFragmentOptions

タイルの最初の部分を包む'TailFragmentEnclosureTag'、で指定されたタグ（'dl'　タイプなら　'dd'）のオプションとなります。

FragmentSeparator

タイル部分のフラグメント（CSV　ファイルのカラム）の間にはさみます。通上はスペースです。

Link

もし値が true　なら、csv ファイルの　(2i+1)-番目めのカラム (からでないなら) は　(2i)-番目のカラムの url となります。

LinkPrefix

この string は（もし Linkが trueなら）、すべての (絶対 url　でない)urlの前に付け加えられます。

NumBlocks

読むブロック数です。空の行がブロックのセパレーターです。

CommentMark

値が emptyでないなら、この char から始まる行をとびます（コメントと仮定します）。これが最初の　char でない場合、例えば、二重引用符で囲まれているか、空白が前にある場合は無効です。

L10n

ローカリゼーション・モジュールでstringを訳する関数 'str()'があるとみなされます。もし nullでないなら、表のヘッド (とタイトル)を訳します。

TranslateFirstFragment

リストの各アイテムの初めのフラグメント(csv ファイルのカラム)を訳します。

TranslateAllFragment

値が trueなら、リストのアイテムの全部のフラグメント (すべてのCSV ファイルのurlでないカラム)の訳をします。

TSSCsvTableReader

このクラスは csv ファイルから表を作成する 'Read()' (及び array　から作成する 'Print()')を協定します。

変数

FileName

CSV ファイル・ネームです。

Separator

カラムの セパレーターです。普通は colon か semi-colon　です。

Enclosure

カラムを包むものです。普通は、二重引用符です。

RowSeparator

行のセパレーターです。普通は、改行コードです。

TrimmingChars

これで指定されたcharsがカラムのまえにきているものはスキップされます。普通は、emptyです。

OnlyEmptyItemsIsEmptyRow

カラムが全部からであれば、空の行と判定します (空の行は、表のセパレーターです)

ContentsOnly

値が trueの場合、表の行のみを作成します（タグ 'table' と 'tbody' を作成しません）。もし、haed row や footer row があるなら、読み飛ばします（Print は aray の haed row や footer row　の部分をプリントしません）。すでに作成中の表に行をつけ加えるために設定します。

SkipHeadRow

値が trueなら、表のヘッドの行（最初の行）をとばします。

FootRow

値が trueなら、最後の行は、表のフットと仮定します。

SkipFootRow

もし trueなら、表のフット（最後の行）をとばします。

NumBlocks

読むブロック数です。空の行がブロックのセパレーターです。

CommentMark

値が emptyでないなら、この char から始まる行をとびます（コメントと仮定します）。これが最初の　char でない場合、例えば、二重引用符で囲まれているか、空白が前にある場合は無効です。

Caption

値が emptyでなければ、表のタイトルです。

L10n

ローカリゼーション・モジュールでstringを訳する関数 'str()'があるとみなされます。もし nullでないなら、表のヘッド (とタイトル)を訳します。

TranslateFirstColumn

表のは表のフット（最後の行）の初めのカラムを訳します。

TranslateAllFirstColumn

値が trueなら、すべての行の最初のカラムの訳をおこないます。

TSSFileSender

ダウンロード・サーバーを作成するためのクラスです。メイン関数は 'Send()'ですが、ヘッドとファイルを別に送る場合は、'SendHead()' と 'SendFile()'を使用できます。ダウンロード・Sーアバーの作成の際に注意しなければならないのは、ダウんんロードできるファイルの制限（例えば、リストにあるファイルのみをダウンロードできる）をすることです。制限がないと、 php ファイルなど、ダウンロードされたくないファイルまで、ダウンロードされてしまいます。

変数

BufferSize

一度に読むブロックのサイズです。

DefaultCType

標準のctypeで、ファイル拡張子から判定できない場合に使われます。

TSSHtmlReader

html ファイルの選んだタグで囲まれた部分だけを読み出すクラスです。選んだタグで囲まれた一個一個をブロックを仮定します。nested tags (リストを含んだリストや、span を含んだ span　など)もサポートしています。メイン関数は 'Read()'です。

変数

FileName

インプット HTML ファイル名です。

KeepCommment

もし trueなら、コメントも読み出します (普通はコメントは飛ばします)。

ContentsOnly

値が falseなら、選んだタグ＋タグのオプションも読み出します（trueなら、囲まれた内部だけを読み出します）。

NumBlocks

読み出すブロック数。

TSSL10n

ローカリゼーション用のクラスで、string を訳する関数　str()を提供します。訳は、 json ファイルから読み込みます。ファイルからの読み込みには 'SetFromFile()'/'AddFromFile()' を使用してください。関数　'str()' は与えられた string　を訳します。クライアント（ブラウザー）側の言語の検出には、 'PreferedLang()' を使えます。

変数

AppName

アプリケーションの名前

AppVersion

アプリケーションのバーション。

LangName

ターゲット言語の言語名。

LangCode

ターゲット言語のコード。

TSSMenu

'AddFromFile()　で　json ファイル から読み込んで (あるいは　'Add()'　で array を提供して)、ナビゲーション・メニューを作成するクラスです。メニュー作成のメイン関数は 'Print()'です。 L10n モジュールを提供すれば、メニューの訳を行います。

変数

Id

メニューの　Id で、toagle menu（メニューを隠す／表す）には必要です。

Options

もし emptyでないなら、メニューを包むタグのオプションとします。

SubMenuOptions

もし emptyでないなら、サブメニューを包むタグのオプションとします。

Toagle

値が true　なら、メニュー・ファイル（または array）内の toagle エレメントを処理します。もし falseなら、toagle エレメントはメニュー作成の際、スキップします。

PrefixTagOptions

もし empty でなくて、メニュー・ファイル　(あるいは array)にメニューの prerfix が設定さされていれば、それを包むタグのオプションとして使用します。

SubMenuPrefixTagOptions

もし empty でなくて、メニュー・ファイル　(あるいは array)にサブメニューの prerfix が設定さされていれば、それを包むタグのオプションとして使用します。

ItemSeparator

メニューのアイテムとアイテムの間にはさみます。コードを読みやすくするだけです。

DisabledItem

メニューの無効アイテム (現在のアイテムで 'disabled'とマークされます). もしアイテムがサブメニューなら、アイテムのリスト (前のあいてむ、現在のサブメニュー・アイテム) を提供することで、純にマークされます (前のアイテムは disabled　とマークされますが、string　の代わりに、一個の　string　のみのリストを用いると、 selected とマークされ、 url は消されません）。

EnabledItemTagOptions

値が　empty　でなければ、enabled　とマークされたアイテムのオプションになります。 css デフォーマットするのに設定します。

DisabledItemTagOptions

値が　empty　でなければ、disabled　とマークされたアイテムのオプションになります。 css デフォーマットするのに設定します。

SelectedItemTagOptions

値が　empty　でなければ、selected　とマークされたアイテムのオプションになります。 css デフォーマットするのに設定します。selected　とマークするには、'DisabledItem'リスト内に、string　でなく、string　を一個のみ服務リストとして入れます。disabled　殿さは、selected　の　url　は残され、の　url野は消されることです。

L10n

ローカリゼーション・モジュールで、価が null　でなければ、 'FL10n->str()' を用いて、メニューの訳を行います。

UseUrl

標準の価は true で、メニューは javascriptコードでなく、URL を使用すると前提します。

UrlParam

このリストの 'key'=>'value' を 'key=value' として、メニューのすべての url に (GET 方として)追加します。

TSSPageCounter

json ファイルを用いて、ページ・カウンターをするためのクラスです。使用するには、 json ファイルにウエブ・サーバー（apacheなど）からの書き込み許可が必要です。もしファイルがまだない場合は、そのフォルダーに、ファイル作成許可が必要です。メイン関数は'Step()'です。

変数

File

カウンターの json ファイル名です。ファイル名は new　で構築するときののパラメーターとして与えることも出来ますが、のちに設定／変更することもできます。

Id

json ファイル内で用いるカウンターの　Id です。関数 'Step()'　の最初のパラメーターでも指定できますが、 'Step()' をパラメーターなしで使用するには、設定が必要です。

AutoAdd

もし trueなら、ファイルに師弟のカウンターがない場合、自動的に作成され、 1　がその価になります。

UnknownId

もし、カウンター Id が指定されていない場合は、このカウンター id を用います。

ライセンス

https://www.gnu.org/licenses/gpl-3.0.ja.html

写真とビデオのライセンス

https://creativecommons.org/licenses/by-nc/4.0/deed.ja