COAP:COAP-2180/week2: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Week 2 [[Help:COAP-2180|COAP 2180]] ==
== Week 2 [[Help:COAP-2180|COAP 2180]] ==


On week two we will look at XML in four ways:
On week two we will look at XML from an End-user point of view.
* What is XML (some short demos)
* Create eBooks using the ePub format
* Editing XML (recall)
* In addition we also may start preparing work for your own DTD (project 3/ week 3)
* XML styling with CSS (Monday)
* DTD architecture (Wednesday)
 
In addition to creating a CSS for XML, we also will start working on your own DTD (project 2/week 3)
 
== Teaching materials ==


; [[Tour de XML]]  
; [[Tour de XML]]  
* This week: DocX and docbook
* This week: DocX and docbook


; Understanding and editing XML (recall)
== Introduction to Electronic books (Monday) ==
* [[XML principles]]
* [[Editing XML tutorial]]
 
; XML with CSS style
* [[CSS tutorial]] (reminder and for catching up)
* [[CSS for XML tutorial]]
* [http://tecfa.unige.ch/guides/te/files/xml-css.pdf xml-css.pdf] (slides)
* [http://reference.sitepoint.com/css SitePoint CSS Reference]. In addition, you also may install the [https://addons.mozilla.org/en-US/firefox/addon/13048 Codeburner for Firefox] add-on.


; Creating a DTD
; Ebooks and ebook formats
* [[DTD tutorial]] (wiki lecture notes)
* [[E-book]] and [[E-book reader]] (Overview pages with links, both need some updating)
* [http://tecfa.unige.ch/guides/te/files/xml-dtd.pdf xml-dtd.pdf] (slides)
* [[ePub]] (overview page for the popular e-book format)


; Examples files
; ePub tools
* [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/ DTD and XML templates example directory]
* Calibre (ePub converter)
* To retrieve these files, I '''strongly''' suggest that you "save link as". If you open a file in a navigator like IE and then save, you may loose information ....
** [[E-book conversion with Calibre]] (this wiki, but not complete)
* Also consider taking the [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/ALLFILES.zip ALLFILES.zip] archive which should include everything. Before unzipping, create a directory.
** [http://calibre-ebook.com/help calibre help]. The main video only explains how to manage books, readers and news, but does not explain conversion. There are several help texts that do....
* Sigil (ePub editor)
** [https://sigil-ebook.com/ Sigil]
** [https://github.com/Sigil-Ebook/Sigil/raw/master/docs/Sigil_User_Guide_0_7_2.epub UserGuide 0.7.2] (epub format)


; Textbook chapters (see also week 1)
'''Documentation'''
If you find that my lecture notes and slides are incomplete, too short or not good enough, reading '''either one or both texts''' is '''mandatory''' !
* Each tool (Calibre, Sigil) has extensive help + tutorials in various forms ....
* ''Learning XML'', Chapter 5 CSS
* ''XML in a Nutshell'', Chapter 13 CSS
* ''XML in a Nutshell'', Chapter 3 Document Type Definitions (start here)
* ''Learning XML'', Chapter 4 Quality Control with Schemas (additional reading)


These chapters are available through the world classroom.
== Wednesday (e-books cont. and XML Schemas) ==


; For the adventurous
* Monday work continued...
* [[:Category:XML|XML Category]] (All XML-related articles in this wiki)
* [http://en.wikipedia.org/wiki/Xml XML] (on Wikipedia)


== Homework 1 - Weeks 1 & 2 ==
* Recall of well-formed vs. valid
 
* What is a schema ? What is a DTD ?
'''Deadline and submission:'''
* [[DTD tutorial]] (wiki lecture notes)
* '''Wednesday week 3''' (before start of class)
* Discussion of possible XML "applications" for HW3 (week 3)
* Use the worldclassroom: https://webster.blackboard.edu/
* Submit the *.xml, the *.dtd and an optional report file (see below)
* Have a look at the week 1 program for resources, e.g. [[Exchanger XML Editor]]
 
=== Task ===
 
Edit an XML document using one of the suggested DTDs below
* Respect the semantics of the elements and the attributes
* Validate your document
* Try to use as many different elements as you can (if appropriate)
* Follow additional directions for each suggested DTD
* Use an existing CSS if it exists, create one if it does not.
 
Bonus:
* Add comments in the DTD or the XML file that explain the XML structure. In addition, write a short report that discusses the DTD and the CSS.
* Styling: improve or create the CSS (if appropriate)
* Good, meaningful contents
 
Do not worry ''too much'' about rendering (display). It is more important that your get the XML editing right, i.e. be able to fill in a dynamic information structure with data. That being said, producing a really good looking CSS will give you a bonus of course.
 
In order to get a maximum score (4/4), your XML must be well-formed, valid and include meaningful data. The DTD and the CSS should documented and there should be a report.
 
=== Example files ===
 
You can choose among the DTDs available at http://tecfa.unige.ch/guides/xml/examples/dtd-examples/
* Make sure to get both the *-template.xml and the corresponding *.dtd file. If available, you also should take the *.css.
* You may suggest another DTD to the instructor, but '''before''' Wed week 2.
 
Some of the DTDs are described in the following table.
{| class="prettytable"
! DTD (difficulty)
! Purpose
! DTD file
! XML start
! CSS
! Additional instructions
 
|-
| Recipe DTD (easy medium)
| Write simple recipes
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/recipe.dtd recipe.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/recipe.xml recipe.xml]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/recipe.css recipe.css]
| Use all tags. Write at least one recipe. Make sure that there is enough information, i.e. a user ought to able to cook this. Look at [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/cuisine.xml this example].
 
|-
| CD_list (medium)
| Create simple CD lists
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/cd-list.dtd cd-list.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/cd-list-template.xml cd-list-template.xml]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/cd-list.css cd-list.css]
| Use most tags. Write at least two entries and at least one that uses most of the tags. Do better than [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/cd-list.xml cd-list.xml]
 
|-
| Recipe Markup Language (hard)
| Write complex recipes
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/recipeml.dtd recipeml.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/recipeml.xml recipeml.xml]
| none
| As above, but only use appropriate tags. Read more in the [http://www.formatdata.com/recipeml/index.html official website].
 
|-
| RSS 0.92 (medium)
| News syndication (usually machine generated)
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/rss-0-92.dtd rss-0-92.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/rss-0-92-template.xml rss-0-92-template.xml]
| none
| Use enough tags to display this in an aggregator. Enter at least 4 URLs. Hint: look at a RSS news feed first !
 
|-
| Simple Docbook (hard)
| Write "real" articles
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/sdocbook.dtd sdocbook.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/sdocbook-template.xml sdocbook-template.xml]
| none (but see [http://www.badgers-in-foil.co.uk/projects/docbook-css/ this])
| Do not use all tags, only the needed ones. Copy/paste from a text you already have.
 
|-
| Instructions (medium)
| Write "how-to" instructions
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/instructions.dtd instructions.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/instructions.xml instructions.xml]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/instructions.css instructions.css]
| Come up with a good "how-to problem". Only use tags you need..
 
|-
| StepbyStep (medium hard)
| Write "how-to" instructions
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/stepbystep03.dtd stepbystep03.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/stepbystep03-template.xml stepbystep03-template.xml]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/stepbystep03.css stepbystep03.css]
| Make up a good "how-to problem". Only use tags you need..
 
|-
| Story grammar (medium)
| Write simple fairy tales
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/story-grammar.dtd story-grammar.dtd]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/story-grammar-template.xml story-grammar-template.xml]
| [http://tecfa.unige.ch/guides/xml/examples/dtd-examples/story-grammar.css story-grammar.css]
| Write a nice fairy tale. Doesn’t need to be your own. Make sure to use the right tags, i.e. think in terms of structure. A very short example is [http://tecfa.unige.ch/guides/xml/examples/recit/story-grammar.xml here].


|}
== Homework 2 (EPub) ==


=== Tips for getting a good grade ===
'''Due:'''
* Before start of class, '''Wednesday week 3'''


'''Evaluation criteria (roughly)'''. See the detailed grid in the world classroom.
'''Task'''


''Work considered as weak:''
(1) Create an [[e-book]] in [[ePub]] format
* Well-formed (but not valid) document using the DTD’s elements
* We suggest using the [http://calibre-ebook.com/ Calibre] converting tool (or similar), but you also can "handcraft" the e-pub file or use an authoring tool like [http://code.google.com/p/sigil/ Sigil] i.e. write a text from start (including some copy/paste of prior work).
* Content suggestion: A term paper you wrote for a non technical class, a technical manual made from open-content tutorials found on the web. A compilation of interesting News. Avoid creating e-books from "complex" HTML pages.
* You can take contents that you didn't create yourself, but in this case your '''name must appear in the e-book''', e.g. as the creator of e-book version and you should write a short foreword for this edition. In addition, materials being uses should be free of copyright or use a creative commons license (or similar)
(2) If you aim for a high grade, turn in an '''optional report''' that describes the intended audience of the e-book, its making (shortly) and other useful comments you may have.


''Work considered as minimalistic:''
'''Tips'''
* Valid document that includes very minimal content. No report.


''Good work includes:''
Prior to creating an e-book, [[E-book#Links|download an e-book]] in ePub format and display it with a reader. You also can unzip the file and study its contents.
* Valid document with an interesting content
* Some CSS


''Excellent work (A-) includes:''
[http://calibre-ebook.com/help Calibre's help] should include enough information to get you started. Before picking up one tutorial, you also can have look at the [http://calibre-ebook.com/demo The official "Grand Tour Video"]
* Inserted useful comments <nowiki><!-- ... --></nowiki> in the XML and/or the DTD or a minimalistic report
* Respect of the DTD's semantics
* Good contents
* Good enough CSS for easy reading


''Very good work (A) includes either one of:''
EduTechWiki also includes a short[[E-book conversion with Calibre]] article. The only useful information so far concerns cleaning up HTML, how to deal with multiple files (i.e. creating a "tables of content file") and there are some links.
* A 1-2 page report that discusses the architecture of the DTD and your opinion of it, e.g. you can describe architecture of the DTD (without going into detailed description of every element !), discuss what you would like to improve, what you liked/disliked, your difficulties, etc. You simply can include this report into the DTD that you resubmit or as word/PDF/HTML file. As you like, presentation of the report doesn't matter.
* Outstanding styling + extended contents


''Brilliant work'' (A+) includes all of the above.
If you use other tools, you are on your own for finding help and other useful information. If you want to start from scratch, Sigil is supposed to be a fairly easy to learn/use authoring tool. It is basically a specialized HTML editor that will package files, images and meta-information into an epub file.


'''Report structure and contents'''
'''Upload'''
* Read [[COAP:COAP-2180/grading form#Report_structure|this]]
* Only turn in the ePUB file (no need to upload any source materials) and your report.

Latest revision as of 00:57, 29 March 2017

Week 2 COAP 2180

On week two we will look at XML from an End-user point of view.

  • Create eBooks using the ePub format
  • In addition we also may start preparing work for your own DTD (project 3/ week 3)
Tour de XML
  • This week: DocX and docbook

Introduction to Electronic books (Monday)

Ebooks and ebook formats
  • E-book and E-book reader (Overview pages with links, both need some updating)
  • ePub (overview page for the popular e-book format)
ePub tools

Documentation

  • Each tool (Calibre, Sigil) has extensive help + tutorials in various forms ....

Wednesday (e-books cont. and XML Schemas)

  • Monday work continued...
  • Recall of well-formed vs. valid
  • What is a schema ? What is a DTD ?
  • DTD tutorial (wiki lecture notes)
  • Discussion of possible XML "applications" for HW3 (week 3)

Homework 2 (EPub)

Due:

  • Before start of class, Wednesday week 3

Task

(1) Create an e-book in ePub format

  • We suggest using the Calibre converting tool (or similar), but you also can "handcraft" the e-pub file or use an authoring tool like Sigil i.e. write a text from start (including some copy/paste of prior work).
  • Content suggestion: A term paper you wrote for a non technical class, a technical manual made from open-content tutorials found on the web. A compilation of interesting News. Avoid creating e-books from "complex" HTML pages.
  • You can take contents that you didn't create yourself, but in this case your name must appear in the e-book, e.g. as the creator of e-book version and you should write a short foreword for this edition. In addition, materials being uses should be free of copyright or use a creative commons license (or similar)

(2) If you aim for a high grade, turn in an optional report that describes the intended audience of the e-book, its making (shortly) and other useful comments you may have.

Tips

Prior to creating an e-book, download an e-book in ePub format and display it with a reader. You also can unzip the file and study its contents.

Calibre's help should include enough information to get you started. Before picking up one tutorial, you also can have look at the The official "Grand Tour Video"

EduTechWiki also includes a shortE-book conversion with Calibre article. The only useful information so far concerns cleaning up HTML, how to deal with multiple files (i.e. creating a "tables of content file") and there are some links.

If you use other tools, you are on your own for finding help and other useful information. If you want to start from scratch, Sigil is supposed to be a fairly easy to learn/use authoring tool. It is basically a specialized HTML editor that will package files, images and meta-information into an epub file.

Upload

  • Only turn in the ePUB file (no need to upload any source materials) and your report.