Demonstration video: How to create CHiLO Book

1. Add badges

You can assess the status of the learning outcomes of CHiLO Books from the Moodle digital badges.

The badge issued for each CHiLO Book is called a "small badge", and the badge issued after earning all the badges of the series or badges of specified CHiLO Books is called a "big badge".

1) Decide the way of assessment.

Moodle badges will be issued when the activity module is completed, which means; achieving passing scores in the Quiz activity module, handing in reports in the Assignment activity module, or posting messages in the Forum activity module. To activate the activity module, there is a need to set the Completion tracking to "ON" on each activity module. But first of all, decide the activity module that best fits the CHiLO Book you are creating.

2) Add activity module

After deciding the activity module, create a course in Moodle, then add the activity module. You can specify the conditions for issuing the badge by adding multiple activity modules but it is only valid for one CHiLO Book for one Moodle course is equivalent to one CHiLO Book.

3) Setting of badge issuing

The small badge is equivalent to the course badge issued in Moodle. As for the big badge, equivalent to the site badge of Moodle.

To learn more about Moodle course badge, and site badge, click the following URL:

4) Save the URL of the created activity module

There is a need to enter the URL of the created activity module on to the CHiLO Producer Spreadsheet which is to be explained later on, so save the URL of the view page of the activity module.

2. Create CHiLO Books

CHiLO Book can be created using CHiLO producer. CHiLO Producer is open source software and a java command line application for producing CHiLO Books.

CHiLO Producer Operating environment

Download CHiLO Producer from GitHub

chilo-producer-master folder

Unzip CHiLO Producer downloaded from GitHub and you will find the following folders under the "chilo-producer-master"  folder.

2-1. Creating work folder

1) Creating "chilo-producer-master/chiloPro/name of your folder" 

Copy "chilo-producer-master/chiloPro/template-series_english" to  "chilo-producer-master/chiloPro/" with the name of your folder.

This folder is the work folder for creating CHiLO Books.

2) Create vol-x folder

i. Copy "vol-n" folder in the "chilo-producer-master/chiloPro/name of your folder", according to the number of CHiLO Books in the series.

ii. Change a name of "vol-n" folders you copied to vol-1,vol-2,vol-3・・・.

2-2. Save and/or upload CHiLO Lecture

1) Save CHiLO Lectures

Save the CHiLO Lectures, explanation texts and figures created in the Design step to each videos, texts, and images folder of each CHiLO Book work folder; vol-1, vol-2, vol-3, ....

Also, prepare thumbnails for CHiLO Lectures and save them in the images folder of each CHiLO Book.

 * vol-x : x indicates the volume of the CHiLO Book.

2) Upload CHiLO Lecture

i. Web version CHiLO Book are delivered by the video-sharing website such as YouTube.

ii. Also, it is essential to enter video-id of  each video you uploaded to the CHiLO Producer Spreadsheet, so you have to keep records of the uploaded video.

2-3. Save the cover image

Save the image file of the book cover and the section cover (inside cover).

Learning Resources 

 * vol-x : x indicates the volume of the CHiLO Book.

2-4. Create structure-books.xlsx

Enter CHiLO Book structure to chilo-producer-master/chiloPro/name of your folder/structure-books.xlsx

1)  "series information" sheet

Configure the information concerning the series.

Main settings

language : Language tag such as "ja", "en"　defined by RFC 5646

creator : Name of the sheet created in the "author.xlsx" which is to be explained later.

published : Issued date of first edition

rights : Owner of copyright

series-name : Name of series of CHiLO Book

series-introduction: Introduction of the series

series-url： URL of the site introducing the series, if any.

cover : Name of "F. Image of section cover" file. Not the book cover of CHiLO Book.

2)  "Book-list" sheet

List of CHiLO Books included in the series

主な設定項目

vol : Number CHiLO Books in the series; vol-1, vol-2, vol-3 and so on, in order.

book-title : Title of CHiLO Book

book-summary : Outline of CHiLO Book

cover : Name of "E. Image of book cover" file. The file name of the cover image of CHiLO Book

identifier : For uniquely identifying CHiLO Book, enter UUID (Universally Unique Identifier). See the following for how to create UUID.

community-url : Currently not in use.

3) "vol-x" sheet

i. Copy the vol-n sheet according to the number of CHiLO Books in the series and alter the sheet name to vol-1,vol-2...

ii. Enter information of the pages to be created in the Body text-section of the CHiLO Book using one row per page from the top.

Main settings

page-type : Select "document" for embedding CHiLO Lectures. Select "test" for assessment of learning outcomes using Moodle activity module.

section-title :Enter the section name of the page.

page-title : The page title is the topic of the CHiLO Lecture.

community: Currently not in use.

main: When the page type "document" is selected, enter the video file name of the CHiLO Lecture.

          When the page type "test" is selected, enter the URL of the view page of the Moodle activity module.

text : Enter the file name of the explanation text corresponding to the CHiLO Lecture.

video-id: Enter when creating web version CHiLO Book. Enter ID of the video uploaded on the video-sharing website.

2-5. Author information

Configure information which displays on the "About the Author" page of Addendum section. The information configured here will be referred to by all the CHiLO Books created under the chiloPro folder.

1)Save image of the author

Learning Resources 

Resource	Details	Location to save the learning resources	Example
E. Image of the author [optional]	The image will be displayed on the "About the Author" page. Resolution: 159x159 JPEG format（Recommended）	chilo-producer-master/chiloPro/common/authorImages/

 * vol-x : x indicates the volume of CHiLO Book.

2) Create author.xlsx

i. Copy "series-infomation" sheet of chilo-producer-master/chiloPro/common/author.xlsx and name the sheet with an easy-to-recognize name.

ii. Enter author information.

2-6. Output CHiLO Book

CHiLO Producer can output two types of CHiLO Books: EPUB3 format EPUB3 CHiLO Book and HTML5 format Web CHiLO Book.

Run the following Java command utilizing command prompt.

CHiLO Book is output to chilo-producer-master/OutputBase/name of your folder/にアウトプットされます。

run.bat -c name_of_your_folder *Windows sh 
run.sh -c name_of_your_folder *Unix-like OS 

command line option:  -t CHiLO Bookのタイプ

3. Check the output CHiLO Book

▶ EPUB3 CHiLO Book

アウトプットされたEPUB3 CHiLO Bookは、chilo-producer-master/OutputBase/name of your folder/epub3にあります。

The contents of the output EPUB3 CHiLO Book may be confirmed using the following ebook reader. 

• For Mac OS: iBooks
• For Windows,Linux: Radium

▶ Web CHiLO Book 

アウトプットされたWeb CHiLO Bookは、chilo-producer-master/OutputBase/name of your folder/htmlにあります。

vol-x/nav.html is the contents page of the web CHiLO Book. Confirm using the Web browser.

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.