COAP:COAP-2180/week3: Difference between revisions

The educational technology and digital learning wiki
Jump to navigation Jump to search
m (Created page with "=== Week 3 COAP 2180 === On week three we will learn how to create our own DTDs * Editing XML should be a prerequisite, i.e. you should be familiar now with a...")
 
Line 1: Line 1:
=== Week 3 [[Help:COAP-2180|COAP 2180]] ===
=== Week 3 [[Help:COAP-2180|COAP 2180]] ===


On week three we will learn how to create our own DTDs
On week three we will learn how to create your own DTDs
* Editing XML should be a prerequisite, i.e. you should be familiar now with a simple DTD's structure
* Defining an information architecture (sketching out elements and attributes)
* Defining an information architecture (sketching out elements and attributes)
* Defining DTD rules and attributes
* Defining DTD rules and attributes
This homework can be a prototype for a part of your term project.


==== Teaching materials ====
==== Teaching materials ====


; [[Tour de XML]] (This week: E-books and X3D)
; [[Tour de XML]] (This week: to be announced)


; Defining a DTD
; Defining a DTD
Line 18: Line 19:
; Textbook chapters  
; Textbook chapters  
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''' !
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''' !
* ''Learning XML'', Chapter 4 Quality Control with Schemas
* ''XML in a Nutshell'', Chapter 3 Document Type Definitions (start here)
* ''XML in a Nutshell'', Chapter 3 Document Type Definitions
* ''Learning XML'', Chapter 4 Quality Control with Schemas (additional reading)


These chapters are available through the world classroom.
These chapters are available through the world classroom.
Line 27: Line 28:
* [http://en.wikipedia.org/wiki/Xml XML] (on Wikipedia)
* [http://en.wikipedia.org/wiki/Xml XML] (on Wikipedia)


==== Homework 1 - Weeks 1/2 ====
==== Homework 3 - Week 3 ====


'''Deadline and submission:'''
'''Deadline and submission:'''
* '''Monday week 3''' (before start of class)
* '''Monday week 4''' (before start of class)
* Use the worldclassroom: https://webster.blackboard.edu/
* Use the worldclassroom: https://webster.blackboard.edu/
* Submit the *.xml, the *.dtd and an optional report file (see below)
* Submit the *.xml, the *.dtd and an optional report file (see below)
Line 36: Line 37:
'''Task'''
'''Task'''


Edit an XML document with the suggested DTDs below
Do '''not worry''' about rendering (display). It will be done in homework 4
* 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
* Bonus: add longer comments in the DTD or the XML file that explain the XML structure and that express your opinions
 
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. Producing a really good looking CSS will give you a bonus.
 
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.
 
Some of the DTDs are described in the following table.
{| class="prettytable"
| <center>'''DTD (difficulty)'''</center>
| <center>'''Purpose'''</center>
| <center>'''file name'''</center>
| <center>'''Additional directions'''</center>
 
|-
| Recipe DTD
 
(easy)
| Write simple recipes
| recipe.dtd
| Use all tags. Write at least one recipe. Make sure that there is enough information to really use it.
 
|-
| Recipe Markup Language
 
(medium)
| Write complex recipes
| recipeml.dtd
| As above, but only use appropriate tags. Hint: find the website of its creator
 
|-
| RSS 0.92
 
(medium)
| News syndication (usually machine generated)
| rss-0-92.dtd
| 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
| sdocbook.dtd
| Do not use all tags, only the needed ones. Copy/paste from a text you already have.
 
|-
| Instructions
 
(medium)
| Write "how-to" instructions
| instructions.dtd
| Come up with a good "how-to problem". Only use tags you need..
 
|-
| StepbyStep
 
(medium hard)
| Write "how-to" instructions
| stepbystep03.dtd
| Make up a good "how-to problem". Only use tags you need..
 
|-
| Story grammar
 
(medium)
| Write simple fairy tales
| story-grammar.dtd
| Write a nice fairy tale. Doesn’t need to be your own.
 
|}


'''Evaluation criteria (roughly)'''
'''Evaluation criteria (roughly)'''

Revision as of 19:18, 5 November 2010

Week 3 COAP 2180

On week three we will learn how to create your own DTDs

  • Defining an information architecture (sketching out elements and attributes)
  • Defining DTD rules and attributes

This homework can be a prototype for a part of your term project.

Teaching materials

Tour de XML (This week
to be announced)
Defining a DTD
Examples files (same as before)
Textbook chapters

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 !

  • 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.

For the adventurous

Homework 3 - Week 3

Deadline and submission:

  • Monday week 4 (before start of class)
  • Use the worldclassroom: https://webster.blackboard.edu/
  • Submit the *.xml, the *.dtd and an optional report file (see below)

Task

Do not worry about rendering (display). It will be done in homework 4

Evaluation criteria (roughly)

Work considered as weak:

  • Well-formed (but not valid) document using the DTD’s elements

Work considered as minimalistic:

  • Valid document that includes very minimal content.

Good work includes:

  • Valid document with an interesting content
  • Some CSS

Excellent work (A-) includes:

  • Inserted useful comments <!-- ... --> in the XML and/or the DTD
  • Respect of the DTD's semantics
  • Good enough CSS for easy reading

Brilliant work (A) includes either one of:

  • A 1 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 doesn't matter.
  • Outstanding styling