Editing Documentation wishlist

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
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.
-
== Common tasks and use-cases ==
+
== 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?
-
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 are the common application layouts and when and how to use them?
-
 
+
*What kind of phrasing to use in menu items, buttons, dialogs, etc. ?
-
Wish-list here - and link to docs when they're created in [[Documentation#Tasks_and_use-cases]].
+
*How to develop themes, icons and graphics for maemo
 +
*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 use the GStreamer *dspsinks
+
*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
 +
*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 ==
-
* How can I play a sound from withing an application?
+
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 record audio from the microphone?
+
 
-
* How can I play a backing track without affecting performance, power usage or blocking I/O?
+
== Porting Howto ==
 +
 
 +
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==  
-
* How to single-step an application on the device?
+
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 debug an application in Scratchbox?
+
-
* How to profile a Maemo application on the device?
+
-
== Style guidelines ==
+
== Using IPv6 ==
 +
The default kernel does not have IPv6 enabled. Some documentation is available at IST-ANEMONE web site.
-
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.
+
== 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).
-
''Suggestion:'' Use tagging & categories to tag documentation as verified with an OS release. --[[User:dneary|Dave Neary]] 16:49, 2 March 2010 (UTC)
+
== Style guidelines ==
-
[[Category:Documentation]]
+
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:Development]]
+

Learn more about Contributing to the wiki.


Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!


Cancel | Editing help (opens in new window)