Re: Request: Tutorials use-cases for documentation
Hi Sascha, Sascha Mäkelä wrote: How to override Silent Profile? what do you mean override? You mean have a user-space application decide not to do what the user has explicitly requested the phone to do? Cheers, Dave. -- maemo.org docsmaster Email: dne...@maemo.org Jabber: bo...@jabber.org ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
RE: Request: Tutorials use-cases for documentation
Hi, Thanks all for your input and brilliant ideas for use cases! Keep them coming :) Cheers, Titta -Original Message- From: maemo-developers-boun...@maemo.org [mailto:maemo-developers-boun...@maemo.org] On Behalf Of ext Aniello Del Sorbo Sent: 12 February, 2010 13:30 To: Dave Neary Cc: maemo-developers@maemo.org; Vayrynen, Titta; Aniello Del Sorbo Subject: Re: Request: Tutorials use-cases for documentation On 12 February 2010 10:43, Dave Neary dne...@maemo.org wrote: Hi, Aniello Del Sorbo wrote: I too am of the ide of answers specific to a particular toolkit. Quick and easy. Answer to the same use case in a different toolkit belong to that particular toolkit category. While the technology used to answer a question is a concern (and not a tiny, easy to resolve one) which will only get worse with the addition of Qt 4.6 and WRT, I think what's most important now is to concentrate on the questions, and having at least 1 high quality answer for each of them, rather than concentrating on what we do if we end up with several answers. Cheers, Dave. Yep and I am thinking, as developer, at all the questions I had while porting xournal to Maemo. Like, in no particular order, just thrown in as they pop up in my mind. I am sure many won't fit the idea you guys have of a Use Case and many would quite low-level, but they could be ispiring: Start: - Where to start from ? Packaging: - Is there a Debian packaging template for Maemo ? - How do I add a subdir to my tree structure? automake, autoconf - How can I make a Debian package that automatically compile and packages for Debian like distributions and Maemo (useful for porting apps) Devel: - How do I make my application aware of the Maemo specific context (i.e. rotation, battery warning, connected/disconnected, calls in/out, keyboard slider, and so on) - Are there some 'standard' gesture I could re-use? - How do Hildon Menu works? - How can I make my own Widget ? - How can I fade in/out stuff ? - How do I read Maemo hardware data: pressure sensitivity, rotation status, light sensor ? - How can I make my code compile on as many Maemo blends as possible - How can I drive the LED ? - How do I access the cameras ? - How do I communicate with other applications ? (camera, modest, contacts, calendar) UI: - How do I develop complex UI interfaces (like Canola or FM Radio do) i.e. rarely using Hildon Widgets Hope this is something you were looking for. -- anidel ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
ext Gary Birkett wrote: excellent idea! try to allow the examples to come from different toolkits. there is more than one method of doing everything. if the same question is answered in both gtk and qt for instance, it will help existing developers to adapt and see the differences in approaching problems. There is a good point behind this which is how to cross use cases with technologies. I don't think the answer is to aim to cover all technologies equally for each use case e.g. How to get a nice % progress bar - In Web Runtime follow these steps. - In Qt follow these other steps. - In GTK+ you would do it this way. - In PyMaemo... I guess developers first make a decision about the toolkit they are going to use and then expect to find documentation specific to that toolkit. Cross-links are nice but that's it. So let's assume that use cases will concentrate on a specific toolkits. The ones we will push will be based on the toolkits officially supported, then others can add the translations to their preferred community supported toolkit if they wish. Looking at http://wiki.maemo.org/Documentation/Use_case_template it is not clear whether such links should be placed in the intro, Related APIs... Tips Tricks would force the template too much. -- Quim Gil open source advocate Maemo Devices @ Nokia ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
ext Gary Birkett wrote: there is more than one method of doing everything. But that's part of the problem, at least for newcomers. They look for the best/easiest way, most likely. Am Freitag, den 12.02.2010, 10:29 +0200 schrieb Quim Gil: There is a good point behind this which is how to cross use cases with technologies. I don't think the answer is to aim to cover all technologies equally for each use case e.g. How to get a nice % progress bar I wouldn't neccessarily expect that the solution to a usecase looks similar with each toolkit. If you then start to explain the exceptions (and why things are different) then you'll quickly blow up the size of the tutorial-style usecase, without helping the reader. It'll only add to the confusion. I guess developers first make a decision about the toolkit they are going to use and then expect to find documentation specific to that toolkit. Cross-links are nice but that's it. [...] Looking at http://wiki.maemo.org/Documentation/Use_case_template it is not clear whether such links should be placed in the intro, Related APIs... Tips Tricks would force the template too much. A title suffix such as (gtkmm) plus wiki categories would help if one wanted to make usecases available for all toolkits. regards, Michael ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
the only reason why i mentioned it is because the accelerometer page on the wiki currently contains such an overview. it shows multiple ways to do the same thing, some in python, some in c and even differences there. it seems to work well and give information to people who need it, no matter which language or method they prefer :) http://wiki.maemo.org/Accelerometers gary On Fri, Feb 12, 2010 at 9:44 AM, Michael Hasselmann mich...@taschenorakel.de wrote: ext Gary Birkett wrote: there is more than one method of doing everything. But that's part of the problem, at least for newcomers. They look for the best/easiest way, most likely. Am Freitag, den 12.02.2010, 10:29 +0200 schrieb Quim Gil: There is a good point behind this which is how to cross use cases with technologies. I don't think the answer is to aim to cover all technologies equally for each use case e.g. How to get a nice % progress bar I wouldn't neccessarily expect that the solution to a usecase looks similar with each toolkit. If you then start to explain the exceptions (and why things are different) then you'll quickly blow up the size of the tutorial-style usecase, without helping the reader. It'll only add to the confusion. I guess developers first make a decision about the toolkit they are going to use and then expect to find documentation specific to that toolkit. Cross-links are nice but that's it. [...] Looking at http://wiki.maemo.org/Documentation/Use_case_template it is not clear whether such links should be placed in the intro, Related APIs... Tips Tricks would force the template too much. A title suffix such as (gtkmm) plus wiki categories would help if one wanted to make usecases available for all toolkits. regards, Michael ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
- Original message - the only reason why i mentioned it is because the accelerometer page on the wiki currently contains such an overview. it shows multiple ways to do the same thing, some in python, some in c and even differences there. it seems to work well and give information to people who need it, no matter which language or method they prefer :) http://wiki.maemo.org/Accelerometers gary I too am of the ide of answers specific to a particular toolkit. Quick and easy. Answer to the same use case in a different toolkit belong to that particular toolkit category. -- Sent from my Nokia N900 On Fri, Feb 12, 2010 at 9:44 AM, Michael Hasselmann mich...@taschenorakel.de wrote: ext Gary Birkett wrote: there is more than one method of doing everything. But that's part of the problem, at least for newcomers. They look for the best/easiest way, most likely. Am Freitag, den 12.02.2010, 10:29 +0200 schrieb Quim Gil: There is a good point behind this which is how to cross use cases with technologies. I don't think the answer is to aim to cover all technologies equally for each use case e.g. How to get a nice % progress bar I wouldn't neccessarily expect that the solution to a usecase looks similar with each toolkit. If you then start to explain the exceptions (and why things are different) then you'll quickly blow up the size of the tutorial-style usecase, without helping the reader. It'll only add to the confusion. I guess developers first make a decision about the toolkit they are going to use and then expect to find documentation specific to that toolkit. Cross-links are nice but that's it. [...] Looking at http://wiki.maemo.org/Documentation/Use_case_template it is not clear whether such links should be placed in the intro, Related APIs... Tips Tricks would force the template too much. A title suffix such as (gtkmm) plus wiki categories would help if one wanted to make usecases available for all toolkits. regards, Michael ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
Hi, Aniello Del Sorbo wrote: I too am of the ide of answers specific to a particular toolkit. Quick and easy. Answer to the same use case in a different toolkit belong to that particular toolkit category. While the technology used to answer a question is a concern (and not a tiny, easy to resolve one) which will only get worse with the addition of Qt 4.6 and WRT, I think what's most important now is to concentrate on the questions, and having at least 1 high quality answer for each of them, rather than concentrating on what we do if we end up with several answers. Cheers, Dave. -- maemo.org docsmaster Email: dne...@maemo.org Jabber: bo...@jabber.org ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
On 12 February 2010 10:43, Dave Neary dne...@maemo.org wrote: Hi, Aniello Del Sorbo wrote: I too am of the ide of answers specific to a particular toolkit. Quick and easy. Answer to the same use case in a different toolkit belong to that particular toolkit category. While the technology used to answer a question is a concern (and not a tiny, easy to resolve one) which will only get worse with the addition of Qt 4.6 and WRT, I think what's most important now is to concentrate on the questions, and having at least 1 high quality answer for each of them, rather than concentrating on what we do if we end up with several answers. Cheers, Dave. Yep and I am thinking, as developer, at all the questions I had while porting xournal to Maemo. Like, in no particular order, just thrown in as they pop up in my mind. I am sure many won't fit the idea you guys have of a Use Case and many would quite low-level, but they could be ispiring: Start: - Where to start from ? Packaging: - Is there a Debian packaging template for Maemo ? - How do I add a subdir to my tree structure? automake, autoconf - How can I make a Debian package that automatically compile and packages for Debian like distributions and Maemo (useful for porting apps) Devel: - How do I make my application aware of the Maemo specific context (i.e. rotation, battery warning, connected/disconnected, calls in/out, keyboard slider, and so on) - Are there some 'standard' gesture I could re-use? - How do Hildon Menu works? - How can I make my own Widget ? - How can I fade in/out stuff ? - How do I read Maemo hardware data: pressure sensitivity, rotation status, light sensor ? - How can I make my code compile on as many Maemo blends as possible - How can I drive the LED ? - How do I access the cameras ? - How do I communicate with other applications ? (camera, modest, contacts, calendar) UI: - How do I develop complex UI interfaces (like Canola or FM Radio do) i.e. rarely using Hildon Widgets Hope this is something you were looking for. -- anidel ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
excellent idea! try to allow the examples to come from different toolkits. there is more than one method of doing everything. if the same question is answered in both gtk and qt for instance, it will help existing developers to adapt and see the differences in approaching problems. gary On Thu, Feb 11, 2010 at 11:44 PM, Dave Neary dne...@maemo.org wrote: Hi everyone, Titta from Lionbridge has been working hard in recent months to understand what is needed to make Maemo's developer documentation rock, and one of her key goals is to ensure that the Maemo community is involved in the creation of documentation - but setting priorities and helping write and improve documentation. Her group has just created a Use-case template in the wiki: http://wiki.maemo.org/Documentation/Use_case_template The idea of a Use-case, as Titta has explained it to me, is that this will be a very focussed document which will explain how to solve a particular problem with the Maemo platform. It's not API documentation, nor is it an overall guide of the platform, it's a stand-alone piece of documentation that helps a developer perform a frequently requested task. Some examples that came to mind when we were talking about this were: * How can I get use accelerometer data on the N900? * How can I get a list of media files on the device? * How can I create a new sharing plug-in for my favourite online service? * How should I store retrieve configuration for my application? Some of these may be API-specific (like the last one gconf), but the API is the question, not the answer. The general principle is: make sure that the question you want answered is a well defined problem that a developer might have, and doesn't make any assumptions about the platfoiorm (that's what the answer's for). So what's next? We want to gather suggestions for use-cases that need documenting, then we'll create a wiki page for each one, then we (and by we, I mean the Maemo Community will answer the questions. The answers will include code snippets, and brief introductions to the purpose of any libraries we use. The end result should be a library of code snippets that could potentially become a Maemo cookbook. So - the floor is open! Don't all shout at once. What stuff would you like to know? Or, having run the gauntlet solved a problem in the past, which things do you think should be more clearly documented explained? Want to help document your struggles? Thanks for all your help! Cheers, Dave. -- maemo.org docsmaster Email: dne...@maemo.org Jabber: bo...@jabber.org ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
On 11 February 2010 23:44, Dave Neary dne...@maemo.org wrote: Some examples that came to mind when we were talking about this were: * How can I get use accelerometer data on the N900? * How can I get a list of media files on the device? * How can I create a new sharing plug-in for my favourite online service? * How should I store retrieve configuration for my application? That's an excellent idea. Despite I am no Maemo developer (yet ;), I will definitely look forward to see such use-cases in place, which would essentially be starting points for beginners on Maemo development field. -- Dawid 'evad' Lorenz * http://adl.pl null://sorry, this signature uses frames ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
On Thu, Feb 11, 2010 at 7:44 PM, Dave Neary dne...@maemo.org wrote: So what's next? We want to gather suggestions for use-cases that need documenting, then we'll create a wiki page for each one, then we (and by we, I mean the Maemo Community will answer the questions. The answers will include code snippets, and brief introductions to the purpose of any libraries we use. The end result should be a library of code snippets that could potentially become a Maemo cookbook. I think it is also a good idea to collect the use case line tutorials found on Maemo talk. There are popular threads on the Development forum which fill this pattern... Regards, -- Anderson Lizardo OpenBossa Labs - INdT Manaus - Brazil ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
On Fri, Feb 12, 2010 at 1:44 AM, Dave Neary dne...@maemo.org wrote: So - the floor is open! Don't all shout at once. What stuff would you like to know? Or, having run the gauntlet solved a problem in the - How do you send a file over bluetooth - How do you make a bluetooth game among several devices (serial connectivity) BTW, note that many questions can soon be answered by use api's provided by qt mobility project: http://labs.trolltech.com/page/Projects/QtMobility -- Ville M. Vainio http://tinyurl.com/vainio ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
Re: Request: Tutorials use-cases for documentation
How to override Silent Profile? ___ maemo-developers mailing list maemo-developers@maemo.org https://lists.maemo.org/mailman/listinfo/maemo-developers
