Thank you very much, Markus! Architecture guide provides much help even being incomplete! I'll do my best to improve it after becoming more proficient with SMW development. Speaking about examples, I think that the best documentation in the world is Qt Assistant in the Qt framework [1] - and because of this the library is so much popular among C++ and Python GUI developers. Each class of the library has the examples of its usage; they also provide rich (but comprehensive) example applications where one can see the way many Qt-classes interact. The SMW community can add useful examples of solving typical tasks on the official SMW wiki - I'm sure it improves the documentation very much.
[1] http://doc.qt.nokia.com/4.6/index.html On Thu, Feb 24, 2011 at 1:40 PM, Markus Krötzsch <mar...@semantic-mediawiki.org> wrote: > > On 24/02/2011 09:41, Yury Katkov wrote: >> >> Hello everyone! >> >> I'm trying to make Semantic MediaWiki extension and observing the >> documentation. I checked the Programmer Guide [1] and found that only >> the Doxygen documentation is currently available. Here are some questions: >> >> 1) Are there any very small example extensions available, whether or >> not some tutorials exist? >> 2) What are the main entry points to the code? For example, how can I >> add a numeric property Age with value 27 to the page User:Paul? Should I >> use SMWDataValueFactory? Or another example: what classes are to be used >> when I want to make an #ask query in my PHP code? >> 3) What classes are interfaces for extension developers and what classes >> belongs to the SMW core and should not be used by us? >> >> Hopefully after figuring out the answers to these questions I will able >> to improve the current documentation and it will make the life of other >> newbie extension developers easier. > > Hi Yury, > > by a happy coincidence I have just realized that we are lacking a good > starting point for understanding SMW's architecture, and I have started to > write a suitable documentation [1]. It is still incomplete, but I hope I can > add further information within the next week. > > I agree that this is important to have, not only for helping people to get > started but also to reduce the effort we have in aligning contributions with > what we intend SMW to be. PHP is not very good for communicating architecture > through code alone ;-) > > I also second your call for examples but there are so many ways in which to > extend SMW that it is hard to come up with example code that is of general > interest. Maybe we could build a collection of LocalSettings.php code > snippets that show how some functions can be extended (e.g. how to register a > new datatype, how to add a sidebar item that shows a property value for the > given page, etc.) > > Regards > > Markus > > [1] http://semantic-mediawiki.org/wiki/Architecture_guide# -- Yury V. Katkov Laboratory of intelligent systems of the Saint-Petersburg National University of Information Technologies, Mechanics and Optics, Russia http://ailab.ifmo.ru ------------------------------------------------------------------------------ Free Software Download: Index, Search & Analyze Logs and other IT data in Real-Time with Splunk. Collect, index and harness all the fast moving IT data generated by your applications, servers and devices whether physical, virtual or in the cloud. Deliver compliance at lower cost and gain new business insights. http://p.sf.net/sfu/splunk-dev2dev _______________________________________________ Semediawiki-devel mailing list Semediawiki-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/semediawiki-devel
