Skip to content

cccties/chilo-producer

Repository files navigation

English version is HERE.

CHiLO Producer

CHiLO Producerとは

CHiLO Producerは、あらかじめ作成された動画やテキストファイルからEPUB3形式のCHiLO Book を出力するJAVAベースのソフトウェアです。

このソフトウェアは、CHiLOⓇ の一部として提供されています。

デモビデオ

https://youtu.be/aySpvTFteiQ

動作環境

  • Java 8 が動作する環境
  • xlsx ファイルが編集できる環境(推奨:Microsoft Office 動作確認:LibreOffice)

利用方法

  1. Java 8( https://java.com/ja/download/ )をインストールします。
    ※Macユーザーの方は、JDK8 ( https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html ) をインストールしてください。
  2. GitHubからCHiLO Producer( https://github.com/cccties/CHiLO-Producer )をダウンロードし、展開します。
    -> 全体の構成はこちらを参照:dir.md

CHiLO Bookを作成するときは、展開した先にある chiloPro ディレクトリを開き、シリーズ毎に chiloPro/templete-series をコピーしていきます。

(root)
 │  run.bat *CHiLOBook出力用のバッチファイル
 │  run.sh  *CHiLOBook出力用のシェルスクリプト
 │  (省略)
 │
 ├─book_templates *CHiLO Bookのテンプレート集
 │   │
 │   ├─basic *Basicデザイン
 │   │
 │   ├─cardview *Cardviewデザイン
 │   │
 │   └─listview *Listviewデザイン
 │  
 ├─chiloPro
 │   │
 │   └─template-series *シリーズディレクトリのテンプレート(このディレクトリをコピーして作成していく)
 │     │  structure-books.xlsx *CHiLO Bookの構造ファイル
 │     │  author.xlsx *著者情報ファイル
 │     │
 │     ├─common *シリーズ内の素材を保存するディレクトリ
 │     │
 │     └─vol-n *各ブックの素材を保存するディレクトリ
 │  
 ├─extension *CHiLO Bookをオンラインで読むためのhtmlファイル
 │   
 └─src *CHiLOBook出力用のjarファイルのソース
 (省略)

CHiLO Book制作の流れ

  1. CHiLO Bookにパッケージする "素材" を準備します。
  2. chiloPro/templete-series を複製し、上記1.で準備した素材を保存します。
  3. ExcelファイルにCHiLO Bookのメタデータを記述します。
  4. CHiLO Bookを出力します。

詳細はこちらをご覧ください -> CHiLO Bookの制作

CHiLO Bookの構造

CHiLO Bookを作る前に、CHiLO Bookの構造を理解しましょう。 -> CHiLO Bookの構造

スタイルを変更する

CHiLO Bookのスタイルを変更したい場合は、 book_templates/ のファイルを変更してください。 -> ブックテンプレートの変更

CHiLO Book 素材サンプル

CHiLO Bookの素材サンプルを公開しています。

https://github.com/cccties/chilo001

ダウンロードして、展開したファイルを、 (root)/chiloPro/ にコピーして、CHiLO Book制作の参考にしてください。

なお、この素材サンプルは、CHiLO Book Libraryで公開している「はじめての情報ネットワーク」の素材となっております。

CHiLO Producer ver.2への移行方法

https://docs.cccties.org/creating-chilobook/migrate-to-chilo-producer-ver2/

課題・質問

このソフトの課題、質問、及び要望はこちらにご記載ください。 -> Issues

ソース

EPUB出力用のjarファイルのソースは src/ に保存されています。 -> src

ビルド方法

以下のMavenコマンドを実行します。

mvn clean package

Licensing

ApacheLicense2.0 ライセンスの元、提供しております。 (see LICENSE.txt)

Copyright

Copyright © 2015 NPO CCC-TIES


About CHiLO Producer

CHiLO Producer is a JAVA-based software which can output an EPUB3 format CHiLO Book using videos and text files created in advance.

This software is provided as a part of CHiLOⓇ.

Demo Video

https://youtu.be/ETXPHxJdXro

Operating environment

  • Environment for Java 8 to operate
  • Environment to edit xlsx files(Recommended:Microsoft Office operation check:LibreOffice)

How to Use CHiLO Producer

  1. Install Java 8(https://java.com/ja/download/).
    ※Mac users: Install JDK8 ( https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html )
  2. Download CHiLO Producer( https://github.com/cccties/CHiLO-Producer ) from GitHub and unzip.
    -> For overall structure, refer to:dir_en.md

If the file has been successfully unziped, chiloPro directory will be created. When creating CHiLO Books, copy chiloPro/templete-series_english for each series.

(root)
 │  run.bat *Batch file for CHiLOBook output
 │  run.sh  *Shell script for CHiLOBook output
 │  (The rest is omitted.)
 │
 ├─book_templates *Collections of templates for CHiLO Book
 │   │
 │   ├─basic *Basic design
 │   │
 │   ├─cardview *Cardview design
 │   │
 │   └─listview *Listview design
 │  
 ├─chiloPro
 │   │
 │   └─template-series_english *Template of the directory of the series(copy this directory for creating).
 │     │  structure-books.xlsx *Structure file of CHiLO Book
 │     │  author.xlsx *Author information file
 │     │
 │     ├─common *Directory for saving materials utilized in the series
 │     │
 │     └─vol-n *Directory for saving materials of each Book
 │  
 ├─extension *html file to read CHiLO Book online
 │   
 └─src *The source of jar files for CHiLO Book output 
(The rest is omitted.)

Workflow of creating CHiLO Books

  1. Prepare "resources" to embed in CHiLO Book
  2. Duplicate chiloPro/template-series_english and save the resources prepared in 1. above
  3. Describe the metadata of the CHiLO Book to the Excel file
  4. Output CHiLO Book

+More details can be found here ->Production of CHiLO Book

Structure of CHiLO Book

Before the production of CHiLO Book, understand the structure of CHiLO Book. -> Structure of CHiLO Book

Change the style

When you want to change the style of the CHiLO Book, change book_templates/ file -> Changing the book tamplate

Samples of CHiLO Book material

We are publicly disclosing materials for CHiLO Book.

https://github.com/cccties/chilo001

Download and copy the expanded file to (root)/chiloPro/ for reference when creating CHiLO Book. These sample materials are of those of "Introduction to Internet Network I" available for free of charge at CHiLO Book Library.

Migrating data to CHiLO Producer ver. 2

https://docs.cccties.org/en/creating-chilobook/migrate-to-chilo-producer-ver2/

Problems and Inquiries

If there are any problems, questions, or requests related to this software, enter here -> Issues

Source

The source of jar file for EPUB output is saved in src/ -> src

To build

Execute the following Maven command

mvn clean package

Licensing

We offer CHiLO Producer under the license of ApacheLicense2.0. (See LICENSE.txt)

Copyright

Copyright © 2015 NPO CCC-TIES

About

CHiLO Producer is a JAVA-based software which can output an EPUB3 format CHiLO Book using videos and text files created in advance.

Resources

License

Stars

Watchers

Forks

Packages

No packages published