1. Prepare Learning Resources
Prepare learning resources to embed onto the CHiLO Book. The learning resources are as follows.
Learning Resources
Resource | Details | Type of Resource | Example |
---|---|---|---|
A. Image of the author [optional] | The image will be displayed on the "About the Author" page. Resolution: 159x159、JPEG format(Recommended) | common in the author | |
B. Image of section cover [required] | Image for display on the inside cover of the section throughout the series. Resolution: 1024x600、JPEG format(Recommended) | common in the series | |
C. Cover [required] | Cover image of the Book Resolution:768x1024、JPEG format(Recommended) | in each Book | |
D. Lecture video [required] | Video of the explanation page. The recommended length of the video is 1-2 minutes. Compress as much as possible in order to embed in EPUB3 format CHiLO Book. Frame rate: 29.97, bit rate: 384kbps, size: 480x360(4:3) or 560x316(16:9) | in each Book | |
E. Lecture video thumbnail [required] | Thumbnail of the explanation video same size as the video, JPEG format (recommended) | in each Book | |
F. Explanation text [required] | Text displayed below the explanation video. Prepared in extension(.xhtml)text file. | in each Book | |
G. Figure [optional] | Embed figures to explain text such as diagrams, charts, graphs and illustration. Recommended resolution: 1024 | in each Book |
2. Configure external systems
2.1 Upload videos
The CHiLO Lecture, which is a series of 1-minute nano-lecture video clips, is embedded in e-Book, in the case of EPUB3 CHiLO Book.
On the other hand, that is delivered by the video-sharing website such as YouTube, in the case of the Web version CHiLO.
従って、Web CHiLO Bookを作成する場合は、lecture videosをVideo-sharing websiteにアップロードします。
また、アップロードしたビデオのvideo-idは、CHiLO ProducerのSpeadsheetに記載する必要があるので、アップロードしたビデオ毎に記録しておきます。
2.2 Add badges
CHiLO Book毎に発行されるバッジをsmall badge、シリーズ内の全て、あるいは特定のCHiLO Bookのバッジを獲得すると発行されるバッジをBig badge と呼びます。
small badgeは、Moodleのcourse badgeに相当します。一方、big badgeは、Moodleのsite badgeに相当します。
Moodleのcourse badge, site badgeの設定は、次をごらんください。
https://docs.moodle.org/29/en/Using_badges#Adding_a_course_badge
2.3 Create Learning Community
Functions of CHiLO Community は、SNS such as Facebook, Twitter, Google+ or LinkdInへのリンクをCHiLO Bookに埋め込むことで実装します。
CHiLO Bookに、SNSへのリンクを埋め込むには、利用したいSNSのグループを作成し、そのURLを後に説明するCHiLO Producerに記載します。
3. Output CHiLO Book
GitHubからダウンロードした、chilo-producer-masterフォルダ内のファイル構造は次のとおりです。
│ run.bat * CHiLO Bookをアウトプットするためのスクリプト(Windows用)
│ run.sh * CHiLO Bookをアウトプットするためのスクリプト(Unix-like OS用)
│
├ src * スクリプトのソースファイル
│
(省略)
│
└ chiloPro * CHiLO Book作成用のフォルダ。
├ common * chiloProフォルダ内に作成される全てのCHiLO Bookが共通で利用するフォルダ
│ │ authors.xlsx * "About the Author" pageの情報を入力するspreadsheet
│ │
│ ├ authorImages * 著者画像を保存するフォルダ
│ ├ images * 共通画像
│ ├ scripts * 通スクリプト
│ └ page-templates * ページデザインを定義しているテンプレートのフォルダ
│ ├ epub3 * EPUB3 CHiLO Book用のテンプレート
│ ├ ext-epub3 * ext. EPUB3 CHiLO Book用のテンプレート
│ └ web * web CHiLO Book用のテンプレート
│
├ sample-series * CHiLO Bookシリーズのサンプル
├ template-series * シリーズフォルダのテンプレート: このフォルダをコピーして作成する (日本語)
│
└ template-series_english *シリーズフォルダのテンプレート: このフォルダをコピーして作成する (英語)
│ structure-books.xlsx * CHiLO Bookの構造ファイル
│
├ vol-n * CHiLO Bookに埋め込む学習リソースを保存するフォルダ:シリーズ内のCHiLO Bookの数だけコピーする
│ ├ images
│ ├ scripts
│ ├ text
│ └ videos
│
└ common * シリーズフォルダ内に作成されるCHiLO Bookが共通で利用するフォルダ
├ images
├ scripts
├ styles * EPUB3 CHiLO Bookのスタイルシート
├ text
├ videos
└ web-styles * Web CHiLO Bookのスタイルシート
1) Copy template folder and save the learning resources
i) Copy "chilo-producer-master/chiloPro/template-series_english" to "chilo-producer-master/chiloPro/" with name of your folder.
ii) Copy "vol-n" folder in the folder you had copied in 1) above, according to the number of CHiLO Books in series.
iii) Change a name of "vol-n" folders you had copied in 2) above to vol-1,vol-2,vol-3・・・.
2) save the learning resources
Save the learning resources prepared according to the destination to save learning resources table.
Destination to save the learning resources
Resource | Destination to save |
---|---|
A. Image of the author | chilo-producer-master/chiloPro/common/authorImages/ |
B. Image of inside cover | chilo-producer-master/chiloPro/name of your folder/common/images/ |
C. Cover | chilo-producer-master/chiloPro/name of your folder/vol-x/images/ * |
D. Explanation video | chilo-producer-master/chiloPro/name of your folder/vol-x/videos/ * |
E. Explanation video thumbnail | chilo-producer-master/chiloPro/name of your folder/vol-x/images/ * |
F. Explanation text | chilo-producer-master/chiloPro/name of your folder/vol-x/text/ * |
G. Image of explanation text | chilo-producer-master/chiloPro/name of your folder/vol-x/images/ * |
* vol-x : x indicates volume of CHiLO Books.
3) Edit Spreadsheets
Entry information about structure information of CHiLO Books and author on the following Spreadsheets.
▶ chilo-producer-master/chiloPro/name of your folder/structure-books.xlsx
structure information of CHiLO Bookを入力するSpreadsheetです。
CHiLO Bookの構造とは、CHiLO Bookのシリーズ情報、シリーズを構成するCHiLO Bookの情報、そして、そのCHiLO Bookを構成するsections of TOC, README, body text, Addendum, and Copyrightの情報であり、1シリーズにつき、structure-books.xlsxを1つ作成しなければいけません。
シリーズ内のCHiLO Bookの冊数やタイトルは、[Book-list] sheet に入力します。それぞれのCHiLO Bookの内容は"vol-x" sheetに記入します。CHiLO BookのBody textセクション以外は、テンプレートファイル(chiloPro/common/templates)で定義されているフォーマットに従って自動的に作成されますが、Body textセクションの中のNumber of sections, number of pages and number of tests can be modified by entering information on the spread sheet of [vol-x] sheet.
▶ chilo-producer-master/chiloPro/common/author.xlsx
"About the Author" page in Addendum sectionは、author.xlsxを参照して作成されます。このスプレッドシートは、chiloPro 以下のフォルダで作成される全てのCHiLO Bookから参照されます。
4) Output CHiLO Book
CHiLO Producer can output two types of CHiLO Books: EPUB3 format EPUB3 CHiLO Book and HTML format Web CHiLO Book.
Run the following Java command utilizing command prompt.
Once you issue a command, the former CHiLO Book will be overwritten, so save it if necessary.
When you failed to output CHiLO Book, refer to Common errors.
▶ EPUB3 CHiLO Book
run.bat -c name_of_your_folder *Windows sh
run.sh -c name_of_your_folder *Unix-like OS
chilo-producer-master/OutputBase/name of your folder/epub3 にアウトプットされます。
▶ Web CHiLO Book
run-html.bat -c name_of_your_folder *Windows sh
run-html.sh -c name_of_your_folder *Unix-like OS
chilo-producer-master/OutputBase/name of your folder/html にアウトプットされます。
5) Check the output CHiLO Book
▶ EPUB3 CHiLO Book
アウトプットしたEPUB3 CHiLO Bookは、次のebook readerで内容を確認できます。但し、テストページとCHiLO Community、つまりSNSへのリンクは、確認できませんので、次の章で説明するdeployを行い、CHiLO Readerで確認してください。
- For iOS,Mac OS: iBooks
- For Android: Gitden EPUB3 Book Reader
- For Windows,Linux: Readium
▶ Web CHiLO Book
OutputBase/name of your folder/html の vol-x/nav.html がweb CHiLO Bookの目次ページです。Webブラウザで確認してください。
You will not be able to check Web CHiLO Book in local environment in the following cases:
- When explanation videos are videos uploaded to YouTube
- When there is an input on fb-app-id of [series-infomation] sheet of chiloPro/SeriesName/structure-books.xlsx
In these cases, check by uploading Web CHiLO Book files to the remote server or run the web server in local environment.