wprssreader/release_notes.txt

RSS Reader Silverlight v1.2
===========================

This example application demonstrates how to build a simple RSS reader for 
Windows Phone using Microsoft Silverlight.

The example has been developed with Silverlight for Windows Phone devices and 
tested to work on Windows Phone 7 and Windows Phone 8.

While testing for compatibility with Windows Phone 8, it was found out that 
the previous implementation did not work after upgrading the project to 
Windows Phone 8.0. It seems that there is some kind of a bug in the Panorama 
control, causing problems if PanoramaItems are created dynamically using 
ItemsSource property. For example, the Panorama's SelectedIndex does not work 
while using ItemsSource and also, when navigating back to the panorama, it 
always resets back to the first PanoramaItem, not the one which was visible 
when navigating deeper.

For this reason, there are now four explicitly defined PanoramaItems in the
main panorama (News, Leisure, Sports, and Tech), and there is a DataMember in
RSSCache for retrieving contents for each of the four pages. Bug report has 
been filed to Microsoft regarding the issue.

This example application is hosted in Nokia Developer Projects:
- https://projects.developer.nokia.com/wprssreader

For more information on implementation and porting visit the wiki pages:
- http://projects.developer.nokia.com/wprssreader/wiki
- http://projects.developer.nokia.com/wprssreader/wiki/porting


What's new
----------

Version 1.2.0: Changes in implementation to support upgrading the application
               to Windows Phone 8.0. Minor UI-changes. Replacing obsolete feeds
               with other feeds.


1. Usage
-------------------------------------------------------------------------------

This is a simple build-and-run solution.


2. Prerequisites
-------------------------------------------------------------------------------

- C# basics
- Microsoft Visual Studio 2010/2012 Express for Windows Phone
- NuGet 2.1 (https://nuget.org/), Visual Studio extension to install and update
  third-party libraries and tools in Visual Studio


3. Project structure and implementation
-------------------------------------------------------------------------------

3.1 Folders
-----------

 |                  The root folder contains the project file, the license 
 |                  information, and this file (release_notes.txt).
 |
 |- RSSReader       Implementation folder.
 |  |
 |  |- Dependencies          DLLs needed by the application.
 |  |
 |  |- Model                 Model implementation.
 |  |
 |  |- Properties            Application property files.
 |  |
 |  |- Resources             Graphic files.
 |  |
 |  |- Views                 Views of the application (panorama, pivot, pages).


3.2 Important files and classes
-------------------------------

| File                           | Description                                |
|--------------------------------|--------------------------------------------|
| FeedPivot.xaml.cs              | Class responsible for displaying available |
|                                | RSS feeds in a pivot control.              |
|--------------------------------|--------------------------------------------|
| RSSService.cs                  | Class responsible for parsing RSS feeds    |
|                                | and creating feed pages formatted as HTML. |
|--------------------------------|--------------------------------------------|
| RestaurantData.cs              | Class describing the restaurant properties |
|                                | shown.                                     |
|--------------------------------|--------------------------------------------|


3.3 Used APIs/Windows Phone Components
--------------------------------------

Microsoft.Phone.Controls.Panorama
Microsoft.Phone.Controls.Pivot
System.Xml.Linq


4. Compatibility
-------------------------------------------------------------------------------

- Windows Phone 7 & Windows Phone 8

Tested on:
- Samsung Omnia 7
- Nokia Lumia 920

Developed with:
- Microsoft Visual Studio 2010 Express for Windows Phone
- Microsoft Visual Studio Express 2012 for Windows Phone


4.1 Required Capabilities
-------------------------

ID_CAP_NETWORKING


4.2 Known Issues
----------------

None.


5. Building, installing, and running the application
-------------------------------------------------------------------------------

5.1 Preparations
----------------

Make sure you have either of the following installed:

1 (For Windows Phone 7):

  * Windows 7 or Windows Vista, may also work on Windows XP
  * Windows Phone SDK 7.1:
    http://go.microsoft.com/?linkid=9772716
  * NuGet 2.1 (https://nuget.org/), Visual Studio extension to install and 
    update third-party libraries and tools in Visual Studio

2 (For Windows Phone 7 and 8):

  * Windows 8
  * Windows Phone SDK 8.0
  * NuGet 2.1 (https://nuget.org/), Visual Studio extension to install and 
    update third-party libraries and tools in Visual Studio
  * The Windows Phone Toolkit - http://phone.codeplex.com/


5.2 Using the WINDOWS PHONE SDK
-------------------------------

1. Open the SLN file:
   File > Open Project, select the file RSSReader.sln
2. Install Silverlight Toolkit for the project. 
   - Open the Package Manager in Visual Studio: 
      Tools -> Library Package Manager -> Package Manager Console
   - Enter installation command to console: PM> Install-Package WPToolkit
3. Select the target, for example 'Windows Phone 7 Emulator'.
4. Press F5 to build the project and run it on the Windows Phone Emulator.


5.3 Deploying to Windows Phone
--------------------------------

Please see the official documentation for deploying and testing applications on
Windows Phone devices:
http://msdn.microsoft.com/en-us/library/gg588378(v=vs.92).aspx


6. License
-------------------------------------------------------------------------------

See the license text file delivered with this project. The license file is also
available online at
http://projects.developer.nokia.com/wprssreader/browser/Licence.txt


7. Related documentation
-------------------------------------------------------------------------------

Learn About Windows Phone Development:
http://msdn.microsoft.com/en-us/ff380145

Windows Phone Dev Center:
http://dev.windowsphone.com/en-us


8. Version history
-------------------------------------------------------------------------------

1.2.0 Changes in implementation to support upgrading the application to 
      Windows Phone 8.0.
1.1.0 Bug fixes and changes based on reviews; published on the Nokia Developer 
      website.
1.0.3 Support for Windows Phone OS version 7.1.
1.0.2 Layout changes and bug fixes.
1.0.1 Bug fixes.
1.0.0 First version.