Documentation wishlist: Difference between revisions

From Maemo Wiki
Jump to navigationJump to search
← Older edit
imported>dneary
imported>sjgadsby
m slight revision of introductory sentences
imported>dneary
Brought up to date. Most requested docs exist now, thus deleted from wishlist.
 
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]]

Latest revision as of 16:49, 2 March 2010

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

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.

Wish-list here - and link to docs when they're created in Documentation#Tasks_and_use-cases.

General software development

  • How to use the GStreamer *dspsinks

Audio support

  • How can I play a sound from withing an application?
  • How can I record audio from the microphone?
  • How can I play a backing track without affecting performance, power usage or blocking I/O?

Debugging aid

  • 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?

Style guidelines

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.

Suggestion: Use tagging & categories to tag documentation as verified with an OS release. --Dave Neary 16:49, 2 March 2010 (UTC)

Retrieved from "http://wiki.maemo.wunderwungiel.pl/index.php?title=Documentation_wishlist&oldid=15165"