Expertiza_Wiki - User contributions [en]

M1752 Implement the Microdata API

2017-10-27T15:09:19Z

Csjain: moved M1752 Implement the Microdata API to CSC/ECE 517 Fall 2017/M1752 Implement the Microdata API

#REDIRECT [[CSC/ECE 517 Fall 2017/M1752 Implement the Microdata API]]

CSC/ECE 517 Fall 2017/M1752 Implement the Microdata API

2017-10-27T15:09:19Z

Csjain: moved M1752 Implement the Microdata API to CSC/ECE 517 Fall 2017/M1752 Implement the Microdata API

=M1752 : Implement the Microdata API=
=='''Introduction'''==

==='''HTML Specification'''===
The WHATWG Microdata HTML specification allows web data to be enriched in that it allows machines to learn more about the data in a web page.
A typical example of real-world using of Microdata is illustrated [https://code.tutsplus.com/tutorials/html5-microdata-welcome-to-the-machine--net-12356 here]

The attributes ‘itemtype’ and ‘itemprop’ are in scope of this project.

More information about the Microdata specification is available [https://html.spec.whatwg.org/multipage/microdata.html here]

Some popular websites like Google, Skype and Microsoft use the Microdata. The number of websites that use Microdata is growing; currently about 13% of websites use Microdata (statistics courtesy w3techs.com)

==='''Servo'''===
Servo is a modern, high-performance browser engine designed for both application and embedded use and written in the Rust programming language.
It is currently developed on 64bit OS X, 64bit Linux, and Android.

==='''Rust'''===
Rust is a systems programming language focuses on memory safety and concurrency. It is similar to C++ but ensures memory safetely and high performance.
More information about the Rust programming language is available [https://servo.org here]
=='''Scope'''==
The scope of this project is to implement initial support for Microdata API specification by allowing the Servo engine to read Microdata API tags from web pages and interpret them in the DOM. This should lay a groundwork for future improvements to implement features to created vCard and JSON data from Microdata on the ServoShell.
Additional project information is available [https://github.com/servo/servo/wiki/Microdata-project here]

=='''Design'''==
As for the initial stage of this project, the scope did not require any major changes to the engine design. We implemented a DOM method to handle appropriate attributes in the Microdata API. The below diagram shows an overview of components involved in the design. The highlighted blocks have been modified.

[[File:Design.png]]

=='''Implementation'''==
The implementation involved updates to the Web Interface Definition Language (webidl) files and its Rust implementation.

===='''HTMLElement.WebIDL'''====
{| class="wikitable"
|-
! Method Name
! Return Type
! Description
|-
| propertyNames()
| String
| Method definition only. The implementation is done in htmlelement.rs

|}

===='''htmlelement.rs'''====

{| class="wikitable"
|-
! Method Name
! Return Type
! Description
! Location
|-
| parse_plain_attributes()
| AttrValue
| This method returns a value of an attribute associated to an the HTML Element.
| '''traits''' Virtual_Methods
|-
| propertyNames()
| Option<Vec<DOMString>>
| This method parses the space-separated values of the 'item-type' attributes'
| '''struct''' HTMLElement

|}

==='''Configuration'''===
The preference <code>[Pref="dom.microdata.testing.enabled"]</code> was added to resources.pref toggle the experimental microdata methods during development.

==='''Testing'''===
testharness is used as the testing framework.

==='''Dependencies'''===
'''html5ever''' - HTML attribute names are fetched in Servo from a lookup file in the html5ever module. The html5ever module was augmented with the 'itemprop' and 'itemtype' attributes for use in Servo.

==='''Pull Request'''===

The pull request used to incorporate our changes upstream is available [https://github.com/servo/servo/pull/19038 here]

=='''References'''==
1. https://servo.org
2. http://html5doctor.com/microdata/
3. https://html.spec.whatwg.org/multipage/microdata.html
4. https://code.tutsplus.com/tutorials/html5-microdata-welcome-to-the-machine--net-12356
5. http://www.servo.org

User:Vhhebbar

2017-10-27T15:07:23Z

Csjain: moved User:Vhhebbar to M1752 Implement the Microdata API: Project wiki

#REDIRECT [[M1752 Implement the Microdata API]]

CSC/ECE 517 Fall 2017/M1752 Implement the Microdata API

2017-10-27T15:07:23Z

Csjain: moved User:Vhhebbar to M1752 Implement the Microdata API: Project wiki

=M1752 : Implement the Microdata API=
=='''Introduction'''==

==='''HTML Specification'''===
The WHATWG Microdata HTML specification allows web data to be enriched in that it allows machines to learn more about the data in a web page.
A typical example of real-world using of Microdata is illustrated [https://code.tutsplus.com/tutorials/html5-microdata-welcome-to-the-machine--net-12356 here]

The attributes ‘itemtype’ and ‘itemprop’ are in scope of this project.

More information about the Microdata specification is available [https://html.spec.whatwg.org/multipage/microdata.html here]

Some popular websites like Google, Skype and Microsoft use the Microdata. The number of websites that use Microdata is growing; currently about 13% of websites use Microdata (statistics courtesy w3techs.com)

==='''Servo'''===
Servo is a modern, high-performance browser engine designed for both application and embedded use and written in the Rust programming language.
It is currently developed on 64bit OS X, 64bit Linux, and Android.

==='''Rust'''===
Rust is a systems programming language focuses on memory safety and concurrency. It is similar to C++ but ensures memory safetely and high performance.
More information about the Rust programming language is available [https://servo.org here]
=='''Scope'''==
The scope of this project is to implement initial support for Microdata API specification by allowing the Servo engine to read Microdata API tags from web pages and interpret them in the DOM. This should lay a groundwork for future improvements to implement features to created vCard and JSON data from Microdata on the ServoShell.
Additional project information is available [https://github.com/servo/servo/wiki/Microdata-project here]

=='''Design'''==
As for the initial stage of this project, the scope did not require any major changes to the engine design. We implemented a DOM method to handle appropriate attributes in the Microdata API. The below diagram shows an overview of components involved in the design. The highlighted blocks have been modified.

[[File:Design.png]]

=='''Implementation'''==
The implementation involved updates to the Web Interface Definition Language (webidl) files and its Rust implementation.

===='''HTMLElement.WebIDL'''====
{| class="wikitable"
|-
! Method Name
! Return Type
! Description
|-
| propertyNames()
| String
| Method definition only. The implementation is done in htmlelement.rs

|}

===='''htmlelement.rs'''====

{| class="wikitable"
|-
! Method Name
! Return Type
! Description
! Location
|-
| parse_plain_attributes()
| AttrValue
| This method returns a value of an attribute associated to an the HTML Element.
| '''traits''' Virtual_Methods
|-
| propertyNames()
| Option<Vec<DOMString>>
| This method parses the space-separated values of the 'item-type' attributes'
| '''struct''' HTMLElement

|}

==='''Configuration'''===
The preference <code>[Pref="dom.microdata.testing.enabled"]</code> was added to resources.pref toggle the experimental microdata methods during development.

==='''Testing'''===
testharness is used as the testing framework.

==='''Dependencies'''===
'''html5ever''' - HTML attribute names are fetched in Servo from a lookup file in the html5ever module. The html5ever module was augmented with the 'itemprop' and 'itemtype' attributes for use in Servo.

==='''Pull Request'''===

The pull request used to incorporate our changes upstream is available [https://github.com/servo/servo/pull/19038 here]

=='''References'''==
https://servo.org
http://html5doctor.com/microdata/
https://html.spec.whatwg.org/multipage/microdata.html
https://code.tutsplus.com/tutorials/html5-microdata-welcome-to-the-machine--net-12356
http://www.servo.org