Documentation wishlist - Revision history

dneary: Brought up to date. Most requested docs exist now, thus deleted from wishlist.

dneary — Tue, 02 Mar 2010 16:49:28 GMT

Brought up to date. Most requested docs exist now, thus deleted from wishlist.

← Older revision		Revision as of 16:49, 2 March 2010
Line 1:		Line 1:
-	~~{{Template:Out of date}}~~

	This page is for collecting desired documentation into a most wanted list. If you feel documentation is missing for something, please add it here and include a rough list of ideas on what that document should contain.		This page is for collecting desired documentation into a most wanted list. If you feel documentation is missing for something, please add it here and include a rough list of ideas on what that document should contain.

-	== ~~UI Guidelines~~ ==	+	== Common tasks and use-cases ==
-	~~How to design the user interface so that it fits in the maemo platform and provides a consistent look and feel to the user?~~	+

-	*What are the common ~~application layouts and when and how~~ to ~~use them?~~	+	Suggestions for APIs or common tasks which need to be documented with code samples, prerequisites, set-up & tear-down. Half way between tutorials and API docs.
-	*What kind of phrasing to use in menu items, ~~buttons~~, ~~dialogs, etc~~. ?	+
-	*How to develop themes, icons and graphics for maemo	+	Wish-list here - and link to docs when they're created in [[Documentation#Tasks_and_use-cases]].
-	*Differences between ~~packages in maemo.org repository~~ and ~~upstream development~~.	+
-	*...	+
-	* See: [~~http://www~~.~~maemo.org/community/hildon_ui.html Hildon UI documents]~~	+

	== General software development ==		== General software development ==

-	*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.	+	How to use the GStreamer dspsinks
-	*Information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices	+
-	*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2	+
-	*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"	+
-		+
-	How to use the ~~770's~~ GStreamer dspsinks~~! This is clearly missing and would be really helpful for many developers.~~	+
-		+
-	*A definitive list of all processes found running under maemo, what they do, how they can be configured, which package (inc ver) they belong within, which programs call them, and their command-line arguments.	+
-		+
-		+
-	~~== High level library docs ==~~	+
-		+
-	~~Moved to [[Talk:Task:Publishing API docs]]~~	+

	== Audio support ==		== Audio support ==
-	~~What is the preferred way of doing~~ audio on the ~~device~~? ~~(if ALSA will not get into the device). Think about games with background tracks and audio effects but without sucking all the battery.~~	+	* How can I play a sound from withing an application?
-		+	* How can I record audio from the microphone?
-	~~== Porting Howto ==~~	+	* How can I play a backing track without affecting performance, power usage or blocking I/O?
-		+
-	~~It would be useful to have some documentation on compiling and porting this to another device. For example the Nokia 9500, which is~~ a ~~device that is crying out for a Nokia supported linux port... and a spell checker. This could also aid porting to palms and other PDA devices.~~	+
-		+
-	~~'''Comment''': If you want other devices ported in linux~~, ~~should register these devices in [http:~~//www.handhelds.org/moin/moin.cgi/PortingToOtherHandhelds handhelds.org wiki]. Post specs of the device, open it, take photos of its guts, identify the main chip, secondary chips and e.g. graphics, touchscreen. Ask the manufacturer about the specs. Porting linux into undocumented device will take forever. Hence, getting a maemo device is the way to go.	+

	== Debugging aid==		== Debugging aid==
-	~~Running GDB seems~~ to ~~be pretty easy in x86 environment but is there any kind of documentation about running debugger in arm processor~~-~~emulated environment~~? How ~~is debugging going~~ to ~~be arranged~~ in ~~hw environment~~? ~~With gdb-stub~~?	+	* How to single-step an application on the device?
		+	* How to debug an application in Scratchbox?
		+	* How to profile a Maemo application on the device?

-	== ~~Using IPv6~~ ==	+	== Style guidelines ==
-	~~The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.~~	+

-	~~== Useful stuff in~~ /~~proc ==~~	+	When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like: "This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.
-	~~I noticed /proc/bootreason - if you say "cat /proc/bootreason" at an xterm shell prompt, you~~ can ~~find out about the circumstances of the last reboot~~. ~~It seems that if the power adapter was plugged in at boot time, you get "charger~~". ~~Other options are~~ "~~pwr_key" (boot via power key)~~ and ~~"sw_rst" (when I ran "/sbin/reboot" from the command line)~~.	+

-	~~== Style guidelines ==~~	+	''Suggestion:'' Use tagging & categories to tag documentation as verified with an OS release. --[[User:dneary\|Dave Neary]] 16:49, 2 March 2010 (UTC)

-	~~When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like~~: ~~"This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.~~	+	[[Category:Documentation]]
		+	[[Category:Development]]

sjgadsby: slight revision of introductory sentences

sjgadsby — Wed, 23 Jul 2008 01:04:56 GMT

slight revision of introductory sentences

← Older revision		Revision as of 01:04, 23 July 2008
Line 1:		Line 1:
	{{Template:Out of date}}		{{Template:Out of date}}

-	This page is for collecting documentation most wanted list. If you feel documentation is missing for ~~some things~~, please add ~~them~~ here and include a rough list of ideas what that document should contain.	+	This page is for collecting desired documentation into a most wanted list. If you feel documentation is missing for something, please add it here and include a rough list of ideas on what that document should contain.

	== UI Guidelines ==		== UI Guidelines ==

qgil: /* High level library docs */ Moved to Talk:Task:Publishing API docs

qgil — Sun, 20 Jul 2008 20:12:46 GMT

High level library docs: Moved to Talk:Task:Publishing API docs

← Older revision		Revision as of 20:12, 20 July 2008
Line 27:		Line 27:
	== High level library docs ==		== High level library docs ==

-	~~The current documents are mostly API-oriented. It would be useful~~ to ~~have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs~~:	+	Moved to [[Talk:Task:Publishing API docs]]
-	* What the library is, what it does, why do you need it	+
-	* What Autoconf/Automake magic is needed to use it	+
-	* Possibly manual compiler switches for compiling and linking	+
-	* Various gotchas, initialization order, other funky stuff	+

	== Audio support ==		== Audio support ==

qgil: {{Template:Out of date}}

qgil — Sat, 28 Jun 2008 19:41:28 GMT

← Older revision		Revision as of 19:41, 28 June 2008
Line 1:		Line 1:
		+	{{Template:Out of date}}

	This page is for collecting documentation most wanted list. If you feel documentation is missing for some things, please add them here and include a rough list of ideas what that document should contain.		This page is for collecting documentation most wanted list. If you feel documentation is missing for some things, please add them here and include a rough list of ideas what that document should contain.

dneary at 17:21, 11 June 2008

dneary — Wed, 11 Jun 2008 17:21:33 GMT

← Older revision		Revision as of 17:21, 11 June 2008
Line 1:		Line 1:
-	~~=DocumentationWanted=~~

	This page is for collecting documentation most wanted list. If you feel documentation is missing for some things, please add them here and include a rough list of ideas what that document should contain.		This page is for collecting documentation most wanted list. If you feel documentation is missing for some things, please add them here and include a rough list of ideas what that document should contain.

-	=UI Guidelines=	+	== UI Guidelines ==
	How to design the user interface so that it fits in the maemo platform and provides a consistent look and feel to the user?		How to design the user interface so that it fits in the maemo platform and provides a consistent look and feel to the user?

Line 13:		Line 12:
	* See: [http://www.maemo.org/community/hildon_ui.html Hildon UI documents]		* See: [http://www.maemo.org/community/hildon_ui.html Hildon UI documents]

-	= ~~Software~~ development =	+	== General software development ==
		+
	*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.		*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.
-	*~~information~~ about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices	+	*Information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices
	*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2		*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2
	*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"		*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"
Line 25:		Line 25:

	== High level library docs ==		== High level library docs ==
		+
	The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:		The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:
	* What the library is, what it does, why do you need it		* What the library is, what it does, why do you need it

dneary: /* More? */

dneary — Wed, 11 Jun 2008 17:20:00 GMT

More?

← Older revision		Revision as of 17:20, 11 June 2008
Line 13:		Line 13:
	* See: [http://www.maemo.org/community/hildon_ui.html Hildon UI documents]		* See: [http://www.maemo.org/community/hildon_ui.html Hildon UI documents]

-	=~~More?~~=	+	= Software development =
	*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.		*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.
-	**See: HOWTO: Making a package for the Application Installer
	*information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices		*information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices
-	*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2 ~~Source for pysqlite2 arm" class="wiki_missing" title="Click to create Wiki page">Source for pysqlite2 arm- This is might be a tall order :-). How about this below,~~	+	*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2
	*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"		*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"

Line 24:		Line 23:
	*A definitive list of all processes found running under maemo, what they do, how they can be configured, which package (inc ver) they belong within, which programs call them, and their command-line arguments.		*A definitive list of all processes found running under maemo, what they do, how they can be configured, which package (inc ver) they belong within, which programs call them, and their command-line arguments.

-	~~--------------------------------------------------------------------------------~~

-	High level library docs~~<BR>~~	+	== High level library docs ==
	The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:		The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:
		+	* What the library is, what it does, why do you need it
		+	* What Autoconf/Automake magic is needed to use it
		+	* Possibly manual compiler switches for compiling and linking
		+	* Various gotchas, initialization order, other funky stuff

-	~~what the library is, what it does, why do you need it <BR>~~	+	== Audio support ==
-	~~what Autoconf/Automake magic~~ is ~~needed to use it <BR>~~	+	What is the preferred way of doing audio on the device? (if ALSA will not get into the device). Think about games with background tracks and audio effects but without sucking all the battery.
-	~~possibly manual compiler switches for compiling~~ and ~~linking <BR>~~	+
-	~~various gotchas, initialization order, other funky stuff <BR>~~	+

-	~~--------------------------------------------------------------------------------~~	+	== Porting Howto ==

-	~~'''Audio support'''<BR>~~
-	~~What is the preferred way of doing audio on the device? (if ALSA will not get into the device). Think about games with background tracks and audio effects but without sucking all the battery.~~
-
-	~~'''Porting Howto'''<BR>~~
	It would be useful to have some documentation on compiling and porting this to another device. For example the Nokia 9500, which is a device that is crying out for a Nokia supported linux port... and a spell checker. This could also aid porting to palms and other PDA devices.		It would be useful to have some documentation on compiling and porting this to another device. For example the Nokia 9500, which is a device that is crying out for a Nokia supported linux port... and a spell checker. This could also aid porting to palms and other PDA devices.

-	'''Comment''': If you want other devices ported in linux, should register these devices in handhelds.org wiki. Post specs of the device, open it, take photos of its guts, identify the main chip, secondary chips and e.g. graphics, touchscreen. Ask the manufacturer about the specs. Porting linux into undocumented device will take forever. Hence, getting a maemo device is the way to go.	+	'''Comment''': If you want other devices ported in linux, should register these devices in [http://www.handhelds.org/moin/moin.cgi/PortingToOtherHandhelds handhelds.org wiki]. Post specs of the device, open it, take photos of its guts, identify the main chip, secondary chips and e.g. graphics, touchscreen. Ask the manufacturer about the specs. Porting linux into undocumented device will take forever. Hence, getting a maemo device is the way to go.

-	~~'''~~Debugging aid~~'''<BR>~~	+	== Debugging aid==
	Running GDB seems to be pretty easy in x86 environment but is there any kind of documentation about running debugger in arm processor-emulated environment? How is debugging going to be arranged in hw environment? With gdb-stub?		Running GDB seems to be pretty easy in x86 environment but is there any kind of documentation about running debugger in arm processor-emulated environment? How is debugging going to be arranged in hw environment? With gdb-stub?

-	~~'''~~Using IPv6~~'''<BR>~~	+	== Using IPv6 ==
	The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.		The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.

-	~~'''~~Other ~~languages'''<BR>~~	+	== Useful stuff in /proc ==
-	*''Português''	+	I noticed /proc/bootreason - if you say "cat /proc/bootreason" at an xterm shell prompt, you can find out about the circumstances of the last reboot. It seems that if the power adapter was plugged in at boot time, you get "charger". Other options are "pwr_key" (boot via power key) and "sw_rst" (when I ran "/sbin/reboot" from the command line).
-	*''Français''	+

-	~~'''Useful stuff in /proc'''<BR>~~	+	== Style guidelines ==
-	I noticed /proc/bootreason - if you say "cat /proc/bootreason" at an xterm shell prompt, you can find out about the circumstances of the last reboot. It seems that if the power adapter was plugged in at boot time, you get "charger". Other options are "pwr_key" (boot via power key) and "sw_rst" (when I ran "/sbin/reboot" from the command line).	+

-	~~'''Style guidelines'''<BR>~~
	When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like: "This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.		When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like: "This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.

dneary: /* UI Guidelines */

dneary — Wed, 11 Jun 2008 17:15:18 GMT

UI Guidelines

← Older revision		Revision as of 17:15, 11 June 2008
Line 11:		Line 11:
	*Differences between packages in maemo.org repository and upstream development.		*Differences between packages in maemo.org repository and upstream development.
	*...		*...
-	* See: Hildon UI documents=	+	* See: [http://www.maemo.org/community/hildon_ui.html Hildon UI documents]

	=More?=		=More?=

dneary: Docs:Wanted moved to Documentation wishlist

dneary — Wed, 11 Jun 2008 16:57:13 GMT

Docs:Wanted moved to Documentation wishlist

← Older revision

Revision as of 16:57, 11 June 2008

65.244.131.151 at 02:21, 26 May 2008

65.244.131.151 — Mon, 26 May 2008 02:21:52 GMT

← Older revision		Revision as of 02:21, 26 May 2008
Line 26:		Line 26:
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

-	High level library docs	+	High level library docs<BR>
	The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:		The current documents are mostly API-oriented. It would be useful to have an overview of all the basic libraries one can (and should) link against (gtk, hildon, osso, gstreamer etc). The doc should explain every library in a few paragraphs:

-	what the library is, what it does, why do you need it	+	what the library is, what it does, why do you need it <BR>
-	what Autoconf/Automake magic is needed to use it	+	what Autoconf/Automake magic is needed to use it <BR>
-	possibly manual compiler switches for compiling and linking	+	possibly manual compiler switches for compiling and linking <BR>
-	various gotchas, initialization order, other funky stuff	+	various gotchas, initialization order, other funky stuff <BR>

	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

-	Audio support	+	'''Audio support'''<BR>
	What is the preferred way of doing audio on the device? (if ALSA will not get into the device). Think about games with background tracks and audio effects but without sucking all the battery.		What is the preferred way of doing audio on the device? (if ALSA will not get into the device). Think about games with background tracks and audio effects but without sucking all the battery.

-	Porting Howto	+	'''Porting Howto'''<BR>
	It would be useful to have some documentation on compiling and porting this to another device. For example the Nokia 9500, which is a device that is crying out for a Nokia supported linux port... and a spell checker. This could also aid porting to palms and other PDA devices.		It would be useful to have some documentation on compiling and porting this to another device. For example the Nokia 9500, which is a device that is crying out for a Nokia supported linux port... and a spell checker. This could also aid porting to palms and other PDA devices.

-	Comment: If you want other devices ported in linux, should register these devices in handhelds.org wiki. Post specs of the device, open it, take photos of its guts, identify the main chip, secondary chips and e.g. graphics, touchscreen. Ask the manufacturer about the specs. Porting linux into undocumented device will take forever. Hence, getting a maemo device is the way to go.	+	'''Comment''': If you want other devices ported in linux, should register these devices in handhelds.org wiki. Post specs of the device, open it, take photos of its guts, identify the main chip, secondary chips and e.g. graphics, touchscreen. Ask the manufacturer about the specs. Porting linux into undocumented device will take forever. Hence, getting a maemo device is the way to go.

-	Debugging aid	+	'''Debugging aid'''<BR>
	Running GDB seems to be pretty easy in x86 environment but is there any kind of documentation about running debugger in arm processor-emulated environment? How is debugging going to be arranged in hw environment? With gdb-stub?		Running GDB seems to be pretty easy in x86 environment but is there any kind of documentation about running debugger in arm processor-emulated environment? How is debugging going to be arranged in hw environment? With gdb-stub?

-	Using IPv6	+	'''Using IPv6'''<BR>
	The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.		The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.

-	Other languages	+	'''Other languages'''<BR>
-	em Português"	+	*''Português''
		+	*''Français''

-	~~en Français"~~	+	'''Useful stuff in /proc'''<BR>
-		+
-	Useful stuff in /proc	+
	I noticed /proc/bootreason - if you say "cat /proc/bootreason" at an xterm shell prompt, you can find out about the circumstances of the last reboot. It seems that if the power adapter was plugged in at boot time, you get "charger". Other options are "pwr_key" (boot via power key) and "sw_rst" (when I ran "/sbin/reboot" from the command line).		I noticed /proc/bootreason - if you say "cat /proc/bootreason" at an xterm shell prompt, you can find out about the circumstances of the last reboot. It seems that if the power adapter was plugged in at boot time, you get "charger". Other options are "pwr_key" (boot via power key) and "sw_rst" (when I ran "/sbin/reboot" from the command line).

-	Style guidelines	+	'''Style guidelines'''<BR>
	When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like: "This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.		When explaining source code and/or techniques experience has shown that specifying the OS version and hardware can be very useful for users. Something like: "This procedure has been tested on a Nokia 770 with ITOS 3.2006.49-2" saves users time and energy.

ludovicus: /* More? */

ludovicus — Sun, 25 May 2008 02:46:12 GMT

More?

← Older revision		Revision as of 02:46, 25 May 2008
Line 14:		Line 14:

	=More?=		=More?=
-	How to make installation packages for application installer - how to do packages end users can install to Nokia 770.	+	*How to make installation packages for application installer - how to do packages end users can install to Nokia 770.
-	See: HOWTO: Making a package for the Application Installer	+	**See: HOWTO: Making a package for the Application Installer
-	information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices	+	*information about how to custom more deeply stuff in Nokia 770, like updating kernel or filesystem, and if it is possible in end user devices
-	Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2 Source for pysqlite2 arm" class="wiki_missing" title="Click to create Wiki page">Source for pysqlite2 arm- This is might be a tall order :-). How about this below,	+	*Step by step tutorial how to develop application using python, python bindings for hildon and preferably with database for data store i.e. pysqlite2 Source for pysqlite2 arm" class="wiki_missing" title="Click to create Wiki page">Source for pysqlite2 arm- This is might be a tall order :-). How about this below,
-	Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"	+	*Writing maemo GUI applications in Python, direct translation of C codes from "Writing maemo GUI applications"

-	How to use the 770's GStreamer *dspsinks! This is clearly missing and would be really helpful for many developers.	+	How to use the 770's GStreamer dspsinks! This is clearly missing and would be really helpful for many developers.

-	A definitive list of all processes found running under maemo, what they do, how they can be configured, which package (inc ver) they belong within, which programs call them, and their command-line arguments.	+	*A definitive list of all processes found running under maemo, what they do, how they can be configured, which package (inc ver) they belong within, which programs call them, and their command-line arguments.

	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------