Jump to content











Photo
- - - - -

Volunteers are needed for documenting WinBuilder


  • Please log in to reply
11 replies to this topic

#1 Nuno Brito

Nuno Brito

    Platinum Member

  • Team Reboot
  • 10423 posts
  • Location:boot.wim
  • Interests:I'm just a quiet simple person with a very quiet simple life living one day at a time..
  •  
    European Union

Posted 01 July 2011 - 02:35 PM

Hello,

We need volunteers to help with the documentation of WinBuilder.

The goal is to ensure that we have a location where people can contribute with their tidybits of experience and allow other people in the future to keep updating this documentation when necessary.

The new documentation is hosted at google code: http://code.google.com/p/winbuilder/

If you are interested and available to help, please send me a personal message or write a reply on this topic.

With this effort, we can make WinBuilder easier to use and understand.

Thank you for helping!

:)

#2 iNf3kt0r

iNf3kt0r
  • Members
  • 5 posts
  •  
    United States

Posted 13 July 2011 - 10:14 AM

Will you be needing any Translators? If so, I can help with Spanish, German, & French.

#3 Nuno Brito

Nuno Brito

    Platinum Member

  • Team Reboot
  • 10423 posts
  • Location:boot.wim
  • Interests:I'm just a quiet simple person with a very quiet simple life living one day at a time..
  •  
    European Union

Posted 13 July 2011 - 11:08 AM

Hi viralnexxus,

Welcome aboard the team!

You can help right away and correspond with Sbaeder, which is leading the documentation effort: http://code.google.c...nbuilder/w/list

Please send me a PM with your gmail/google account so that I can add you to the list of contributors at the new winbuilder site. A page with the names of contributors involved will also be created to ensure that your work won't go unnoticed in the books of winbuilder history.

At present, the focus is creating simple and straightforward pages in English language like this one: http://code.google.c...wiki/txtaddline

:smiling9:

#4 Wonko the Sane

Wonko the Sane

    The Finder

  • Advanced user
  • 13329 posts
  • Location:The Outside of the Asylum (gate is closed)
  •  
    Italy

Posted 13 July 2011 - 11:42 AM

At present, the focus is creating simple and straightforward pages in English language like this one: http://code.google.c...wiki/txtaddline

...which still needs to be translated to English ;):
http://reboot.pro/14736/page__st__134

Seriously, can we agree to a "Format" for the entries, like:
  • Command:
  • Command Options:
  • Syntax:
  • Example(s):
  • Related:
And also agree in using the actual command as subject?
Like:

This command adds .....

or even better directly:

Add a text line ....

as opposed to:

With this command we can add ....


A good example IMHO is the command line help you can find here:
http://ss64.com/nt/

Please not how useful is the "Related" part at the bottom of the pages. :smiling9:

:cheers:
Wonko

#5 paraglider

paraglider

    Gold Member

  • .script developer
  • 1691 posts
  • Location:NC,USA
  •  
    United States

Posted 13 July 2011 - 12:10 PM

For commands I like the format I used in my docs for the commnonapi. Use of color and a html table for the parameter descriptions makes documentation easier to read. However don't know enough about the wiki to know if it supports full html including style sheets.

I would suggest an index - something like:

http://wb.paraglidernc.com/Help/

#6 Wonko the Sane

Wonko the Sane

    The Finder

  • Advanced user
  • 13329 posts
  • Location:The Outside of the Asylum (gate is closed)
  •  
    Italy

Posted 13 July 2011 - 12:32 PM

For commands I like the format I used in my docs for the commnonapi. Use of color and a html table for the parameter descriptions makes documentation easier to read. However don't know enough about the wiki to know if it supports full html including style sheets.

Yes, that is very well done and easily readable :smiling9: .

I like also the
  • Tips
and
  • Remarks
sections, though the use of the "Remarks" seem like being "variable" in your pages as well, compare (examples) this:
http://wb.paraglider.../Hive_Load.html
with this:
http://wb.paraglider...ister_File.html
in the first the Remarks is used to tell what the actual command does, in the second this info is totally amiss and Remarks is used (IMHO) the "right way".


;)
Wonko

#7 sbaeder

sbaeder

    Gold Member

  • .script developer
  • 1334 posts
  • Location:usa - massachusettes
  •  
    United States

Posted 13 July 2011 - 03:44 PM

...which still needs to be translated to English :cheers::
http://reboot.pro/14736/page__st__134

The approach right now is to do some BASIC reformatting into the WIKI syntax used (which is 99% plain text) from the convoluted HTML files we had to start with.

So - YES, I think we all agree that some basic guidelines and layout for the Keyword and API related files is needed.

@paraglider - Yes, I am trying to use table format on converting your API files - again, not that easy to have color coding and such in a simple WIKI markup language, but I think they are looking OK...

Feel free to BROWSE around in the wiki area - and not just that one file...I am about 50-60% finished with the basic editing - (the grunt work), and still learning how to use the wiki syntax to best advantage...

But, some of the goals of a page for each "function" (internal or API) is the start, then the higher level stuff, then navigation, and of course - export to a CHM file, etc...I also want to use the method of "crawl, walk, run", so keep that in mind as we go from a complete standing start to a crawl... ;)

So, Which of you wants to also HELP do the work...??? :smiling9:

THANKS for the suggestions,
;)

#8 sbaeder

sbaeder

    Gold Member

  • .script developer
  • 1334 posts
  • Location:usa - massachusettes
  •  
    United States

Posted 13 July 2011 - 03:55 PM

I would suggest an index - something like:

http://wb.paraglidernc.com/Help/

Yes - will be using the sidebar navigation process of the WIKI, but will be essentially the same as this.

See the internal wiki guidelines for more information on it.

#9 Wonko the Sane

Wonko the Sane

    The Finder

  • Advanced user
  • 13329 posts
  • Location:The Outside of the Asylum (gate is closed)
  •  
    Italy

Posted 13 July 2011 - 03:59 PM

So, Which of you wants to also HELP do the work...??? ;)

Hmmm. :blink:
Right now I self-appointed myself Internal Controller and paraglider is obviously Technology Manager :cheers:
Let me think :smiling9:, who is Mario? ;)
Spoiler


:cheers:

;)
Wonko

#10 paraglider

paraglider

    Gold Member

  • .script developer
  • 1691 posts
  • Location:NC,USA
  •  
    United States

Posted 13 July 2011 - 11:48 PM

Yes looks like limited html is supported. Style sheets, either inline or external, appear not to be in the list.

http://code.google.c...wiki/WikiSyntax

You could link to external pages but would loose a lot of the benefits of a wiki:

Why are you not hosting an existing wiki system like MoinMoin, TWiki, or MediaWiki?

Most of the existing wiki products cannot scale to the size and concurrency that we expect, so we had to design one to work to our demands, using Google's infrastructure. In addition, we believe that tools are most useful when they are easy to use and well integrated into the collaborative development environment. So, we are offering a simple wiki that works well with our existing tools. If you find that your project needs some highly specialized formatting, you can link to Google Sites, Google Docs and Spreadsheets, Google Groups, or other pages hosted elsewhere on the Internet.



#11 sbaeder

sbaeder

    Gold Member

  • .script developer
  • 1334 posts
  • Location:usa - massachusettes
  •  
    United States

Posted 14 July 2011 - 02:04 AM

Yes looks like limited html is supported. Style sheets, either inline or external, appear not to be in the list.

http://code.google.c...wiki/WikiSyntax

You could link to external pages but would loose a lot of the benefits of a wiki:

Yes - not the best for all the fancy stuff, but workable, and better than what we had (at least IMNSHO)

#12 sbaeder

sbaeder

    Gold Member

  • .script developer
  • 1334 posts
  • Location:usa - massachusettes
  •  
    United States

Posted 21 July 2011 - 10:10 PM

OK - at least Wonko (to help me out on "internal control") and Paraglider (to help me out on "technology") should be able to look at the current state of the Wiki, and if really brave, download the chm file to critique... B)

Of course anyone else is welcome as well...Let me know if you want to help out!!!

While not quite as "nice/fancy" as the current help, it should be more "manageable" and "upgrade-able"...

As a reminder...WinBuilder's project home on google is http://code.google.com/p/winbuilder/




0 user(s) are reading this topic

0 members, 0 guests, 0 anonymous users