Changes

Jump to: navigation, search

Dave Developer's Wiki Conventions

2,849 bytes added, 10:59, 14 January 2014
m
no edit summary
== Keeping updated on '''DAVE Embedded Systems''' Developer's wiki pages modifications ==
=== RSS Feeds ===
 
In order to keep customers updated on '''DAVE Embedded Systems''' Developer's wiki new pages or modified information, all the updates are aggregated and made available using a RSS (Rich Site Summary) feed. RSS feeds can be read using RSS feed "readers" or "aggregators". Once the user subscribes to a feed (for example by clicking a feed icon in a web browser that supports RSS), the RSS reader checks the user's subscribed feeds regularly for any updates that it finds, and provides a user interface to monitor and read the feeds. The following page shows an example of feed aggregation:
 
 
[[File:Dev-wiki-rss.png|600px|frameless|border]]
 
Each entry on this page represents a page modification, with a link to the modified page and a link to a page that summarizes the differences between the previous and recent version.
 
Please read the [http://en.wikipedia.org/wiki/RSS RSS info page] on Wikipedia to learn more on the Rich Site Summary web feed format.
 
=== Where to find RSS feeds ===
 
RSS feeds can be accessed from some particular wiki pages, e.g. the Category pages dedicated to the CPU modules. For example, the feed related to the [[:Category:Naon|Naon]] CPU module can be found in the [[:Category:Naon|Naon]] category page (in the [[:Category:Naon#Naon_RSS_Feed | Naon RSS Feed]] section).
 
=== How to subscribe to a RSS feed ===
 
The following procedure describes how to subscribe to a RSS feed using the Sage extension for the Firefox browser:
 
# Install the Sage Firefox extension selecting Tools->Add-ons on the Firefox menù bar and searching "Sage" as Add-on<br><br>
# Restart Firefox to enable Sage and click to the "Leaf" icon close to the address bar<br>[[File:sage-01.png|600px|frameless|border]]<br><br>
# Click on the RSS feed you want to subscribe to (for example <newsfeedlink feed="Naon Pages Updates" format="rss">Naon Pages Updates</newsfeedlink> from the [[:Category:Naon|Naon Category]] page)<br><br>
# Drag the address icon from the Firefox address bar to the Sage left panel<br>[[File:sage-02.png|600px|frameless|border]]<br><br>
# Click on the feed bookmark on the Sage left panel to read the news related to wiki pages updates:<br>[[File:sage-03.png|600px|frameless|border]]<br>
 
== Page content remarks ==
 
=== Board/Application Specific Information ===
 
When reading a general topic, user can see a section like that starts or include a warning like the following
 
{{Board Specific Information|text=The text should explain which specific system or family we are talking about}}
 
In this case everything written inside the box and/or it's containing section should not be applied generically to the main topic but only to a specific target.
 
== Page content specific formats ==
=== Terminal Output ===
</pre>
On the other side, command/output sent/received on user development machine (e.g. [[:Category:DVDK|Dave '''DAVE Embedded Systems''' Virtual Development Kit]]) looks like:
<pre class="workstation-terminal">

Navigation menu