PMC Documentation Meeting 20100604

From ADempiere
Jump to: navigation, search
This Wiki is read-only for reference purposes to avoid broken links.

Date: 2010-06-04
Time: 11AM GMT
Venue: irc #adempiere-team
Support Spreadsheet: Adempiere PMC Documentation
Chat times in GMT-5


(06:02:59) CarlosRuiz: Hi
(06:05:13) needle58: hi Carlos, i have to excuse me, we had a breakdown of electricity here, i need some more time to take care, i hope to be back soon
(06:05:56) Mike [proxyuser@bas3-ottawa10-1279601097.dsl.bell.ca] entered the channel.
(06:05:58) Mike ahora se llama Guest62165
(06:06:04) CarlosRuiz: ok Dirk
(06:07:04) Guest62165 ahora se llama MikeMcKay
(06:07:31) MikeMcKay: Morning. Single dad today - can't stay for the full hour.
(06:07:39) CarlosRuiz: Hi Mike, I've seen the excellent work you're doing organizing the wiki - thank you very much
(06:08:00) MikeMcKay: Welcome. Was wondering if you have any comments.
(06:08:21) MikeMcKay: FAQs will be easy enough but How Tos are daunting.
(06:09:31) MikeMcKay: I think the style guide is fine and I've tried to apply it to a few pages.
(06:09:51) CarlosRuiz: no comments until now - I like how you're doing it
(06:10:52) MikeMcKay: One thing I've realized is that we can't use HowTo as the first word in the page title or the Category:HowTo will be a mass of documents under the letter H. - Not much help.
(06:11:09) MikeMcKay: Any ideas on an index?
(06:11:32) CarlosRuiz: do you mean the category page?
(06:12:21) MikeMcKay: Sorry, I mean more of a table of contents.
(06:13:01) CarlosRuiz: ah - ok - look at this, not sure if that helps:
(06:13:01) CarlosRuiz: http://www.adempiere.com/index.php/Category:Manual
(06:13:21) CarlosRuiz: the man pages are too many all starting with the same ManPage prefix
(06:13:53) CarlosRuiz: so, I prefixed them with a letter to "index" within the category page
(06:15:10) CarlosRuiz: that is done simply writing in the category the letter(s) to index
(06:15:16) CarlosRuiz: for example this page:
(06:15:16) CarlosRuiz: http://www.adempiere.com/index.php/ManPageW_FreightCategory
(06:15:18) trifon: Carlos, you mean you put suffinx.
(06:15:24) trifon: i see sufix on the man pages.
(06:15:28) CarlosRuiz: is categorized as
(06:15:28) CarlosRuiz:
(06:16:07) CarlosRuiz: and in category page is indexed under W (Window) ordered in the letter F
(06:16:38) CarlosRuiz: does that help?
(06:18:07) CarlosRuiz: yep trifon - that was to index within the suffix in the category page
(06:18:36) MikeMcKay: Yes. Neat method! This is a great way to set up the index. Could we also create table of contents page manually - like an ordered reading list of the most important pages?
(06:19:47) CarlosRuiz: yep - I think we can - in the category page you can edit as any page and that will be added before the index
(06:21:11) MikeMcKay: Does that mean we can manually sort the categories?
(06:22:12) CarlosRuiz: no, we can add a sort key
(06:22:16) CarlosRuiz: http://www.mediawiki.org/wiki/Help:Categories
(06:22:37) CarlosRuiz: but - for example we can edit the category page and add links to prominent pages on top
(06:24:12) MikeMcKay: So if we treat a category like its own book, we could add the table of contents at the top of the category page? This could work.
(06:25:32) CarlosRuiz: not sure - I think TOC is not for categories
(06:26:07) CarlosRuiz: but - you can add a page to several categories
(06:26:19) MikeMcKay: Maybe I'm trying to create a paper model where it is not needed.
(06:26:47) CarlosRuiz: we could maybe split the categories in more detailed ones
(06:26:47) CarlosRuiz: i.e. HowTos - the main category
(06:26:47) CarlosRuiz: but also we can have categories like
(06:26:47) CarlosRuiz: HowToAccounting
(06:26:47) CarlosRuiz: HowToSales
(06:28:21) MikeMcKay: What I'm looking for is a way for people to find information when they don't know what they are looking for. The Categories are like an index at the back of the book - helpful if you know what you want.
(06:29:06) CarlosRuiz: yes - I think we still need an index page for that - perhaps manually created  :-(
(06:30:38) MikeMcKay: Manually is fine - it is just to get people started. (But I'm sure you could figure out a way to automate it eventually.)
(06:31:54) MikeMcKay: I'll start one this next week as I continue to apply the templates and styles to the How To pages.
(06:32:34) MikeMcKay: I'm going to have to sign off - have to get the girls ready for school. Meet again in two weeks?
(06:33:39) CarlosRuiz: thank you very much Michael
(06:33:45) CarlosRuiz: sure - in two weeks
(06:33:59) MikeMcKay: Pleasure.
(06:49:05) needle58: i am back
(06:51:03) CarlosRuiz: Hi Dirk
(06:51:42) needle58: hi Carlos
(06:51:58) CarlosRuiz: still nobody answer on the wiki migration thread  :-) typical answer from this community
(06:51:58) CarlosRuiz: fast to appropiate work from others - slow to volunteer even on writing a forum post  :-D
(06:52:52) CarlosRuiz: I suppose we need to start "marginalizing" non-contributors from PMC - I'm preparing a first round of depuration of non-contributors from PMC
(06:53:04) CarlosRuiz: but we need to keep encouraging those who are active
(06:53:14) needle58: well, i did also not find any time to work on the categories in the mean time
(06:53:27) needle58: but i promise :)
(06:54:04) needle58: i ask isaiah if he can prepare the main wiki for upgrade over the weekend
(06:54:42) CarlosRuiz: great
(06:55:06) needle58: do we have some ftp access for image upload currently?
(06:55:26) CarlosRuiz: as always - just let me know if you have problems I can help
(06:55:38) CarlosRuiz: let me check how did I upload the manual images .....
(06:55:43) needle58: i found jshot, a utility to easily do screen shots and upload them
(06:56:03) needle58: unfortunately without http, only ftp or others
(06:56:27) needle58: mediawiki has an import feature
(06:56:41) CarlosRuiz: I think I did with sftp
(06:56:51) CarlosRuiz: or scp - don't remember exactly
(06:57:18) CarlosRuiz: ah ... wait - no, I found a tool
(06:57:33) CarlosRuiz: that was some years ago - let me review my notes
(06:57:38) needle58: good
(06:58:43) CarlosRuiz: pywikipedia
(06:59:03) needle58: sounds familiar to me
(06:59:32) needle58: as if i had tried it also already
(06:59:35) CarlosRuiz: I took the screenshots locally - and then upload the manual pages and screenshot files with pywikipedia
(07:00:36) needle58: thanks for the info, i will see what can be done to make it as easy as possible for mass upload