Author Topic: LinuxMCE Developer's Guide  (Read 1911 times)

Ender

  • Regular Poster
  • **
  • Posts: 19
    • View Profile
LinuxMCE Developer's Guide
« on: December 07, 2007, 01:50:58 pm »
Hi guys,

I've started a Developer's Guide for LinuxMCE, but it's document (see attachment) and I don't have to time to create wiki pages for it. I've started one here http://wiki.linuxmce.org/index.php/Developers_Guide. Can anyone help me with this?

Regards,
Ender

Hagen

  • Guru
  • ****
  • Posts: 437
  • LMCE wannabe user
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #1 on: December 07, 2007, 02:09:31 pm »
I am on it.
Just a quick question, you have just pasted the contents straight in and want a 'facelift' only?

Ender

  • Regular Poster
  • **
  • Posts: 19
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #2 on: December 07, 2007, 02:13:34 pm »
I guess we need to add the pictures from document and to format the page to have a summary and header.

Thanks.

Hagen

  • Guru
  • ****
  • Posts: 437
  • LMCE wannabe user
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #3 on: December 07, 2007, 02:15:32 pm »
yup, a 'facelift'  ;)
I'm on it

Hagen

  • Guru
  • ****
  • Posts: 437
  • LMCE wannabe user
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #4 on: December 07, 2007, 03:51:02 pm »
Done a bit now, hope it helps some.
I don't know when I will be able to continue, perhaps later this evening.
Please comment on the layout as I had to make some concessions due to the limited Wiki formating.

Also I could not get the pictures to show either, the syntax is correct (according to the Wiki 'how to'), will look further into that as well.

danielk

  • Guru
  • ****
  • Posts: 153
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #5 on: December 07, 2007, 04:19:15 pm »
Cool!  ;D

Ender

  • Regular Poster
  • **
  • Posts: 19
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #6 on: December 07, 2007, 05:12:10 pm »
I think Wiki doesn't link png's, it doesn't recognize them as pictures. Maybe we should try jpeg's ? :)

Ender

  • Regular Poster
  • **
  • Posts: 19
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #7 on: December 07, 2007, 05:14:31 pm »
We need few new lines between command names (search for 'Keyboard input').  ;D

Ender

  • Regular Poster
  • **
  • Posts: 19
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #8 on: December 07, 2007, 05:17:49 pm »
Yeap, adding it as a jpeg did the job  8)

Hagen

  • Guru
  • ****
  • Posts: 437
  • LMCE wannabe user
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #9 on: December 07, 2007, 06:16:42 pm »
Yeap, adding it as a jpeg did the job  8)
Quite funny that the 'how to' uses png...
in the words of Homer: 'Doh!'

I'll switch to jpg for them all now

Hagen

  • Guru
  • ****
  • Posts: 437
  • LMCE wannabe user
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #10 on: December 07, 2007, 06:55:48 pm »
We need few new lines between command names (search for 'Keyboard input').  ;D
Yes, looks like the '-' you used in the original tells wiki to continue on the above line, sort of 'reverse line break'

Matthew

  • Douchebag
  • Addicted
  • *
  • Posts: 567
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #11 on: December 07, 2007, 07:16:13 pm »
That is an excellent resource, thank you!

I like the idea of the entire guide being rooted in a single page that specifies all of the architectural blocks (and messaging/calls between them) in summary. With the summary in a named heading, telling the name, description, and source code filespecs & DB tablenames / config filespecs, linked to another page detailing that component programming notes, like data format and other lower level detals. Like for example its link in a chain of code paths in a given use case. Then we can link pages in the main wiki that are consumer user documentation to their developer's guide summary section on the main page, clickable to more detailed info on its own page.

It would also be very valuable for the programmer's guide subpages each to specify which version of LMCE and the component is being documented. Including those version numbers in the page editor's summary field when updating it for a new version will let later readers just find their old version's docs (if it exists) by looking at the page's history tab.

Thanks again for kicking this off! I encourage everyone who can to at least add source code filespecs and DB tablenames / config filespecs to any section they know is relevant.

dopey

  • Guru
  • ****
  • Posts: 222
    • View Profile
Re: LinuxMCE Developer's Guide
« Reply #12 on: December 08, 2007, 06:56:20 am »
I echo Mathew's comments, but I'd like to also add that everyone posting in the forum should read that page (unless you're already a guru)! It made for enlightening read. Although I understood how DCERouter worked at a high level, this summarizes a lot of the details very well.

Thank you!