Re: [SMW-devel] documentation, entry points, interface classes
[Taking this back to the list] On 28/02/2011 23:13, Stefan Harwarth wrote: Hi Markus, thank you very much for establishing this page, it is really tough to try understanding the interactions between the objects just by reading the code/doxygen - actually I started to write my own little documentation. I'm really looking forward to more content on this page! Yes, and I hope I will soon have some time to add it. My suggestions for small examples would be stuff like how to add semantic data to a page programmatically, how to perform a query and evaluate the results create your own datatype with only a few lines of commented code - well, maybe except for the own datatype. I think my thread from last October Problem with storing semantic attributes in a parserhook shows that such information would help a lot. This would indeed be helpful. If I find the time, then I might set up some such examples. Meanwhile, contributions are welcome. Regards, Markus Am 24.02.2011 11:40, schrieb Markus Krötzsch: 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# -- 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 -- 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
Re: [SMW-devel] documentation, entry points, interface classes
Hi, Great idea. Maybe, it would be good to have a small introduction to the way SMW is integrated into MW, answering questions like * When does SMW come into play if MW is run? * What hooks are used? * What parsers are extended? * What globals are needed? Best, Benedikt PS: Can someone tell me: Why does SMWDataValue not have a method getProperty()? -- Karlsruhe Institute of Technology (KIT) Institute of Applied Informatics and Formal Description Methods (AIFB) Benedikt Kämpgen Research Associate Kaiserstraße 12 Building 11.40 76131 Karlsruhe, Germany Phone: +49 721 608-47946 (!new since 1 January 2011!) Fax: +49 721 608-46580 (!new since 1 January 2011!) Email: benedikt.kaemp...@kit.edu Web: http://www.kit.edu/ KIT - University of the State of Baden-Wuerttemberg and National Research Center of the Helmholtz Association -Original Message- From: Yury Katkov [mailto:katkov.ju...@gmail.com] Sent: Friday, February 25, 2011 3:11 PM To: Markus Krötzsch Cc: SMW developer list Subject: Re: [SMW-devel] documentation, entry points, interface classes 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 smime.p7s Description: S/MIME cryptographic signature -- 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
Re: [SMW-devel] documentation, entry points, interface classes
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
