[openbeosmediakit] AW: Re: Media Kit documentation

  • From: stofftiere@xxxxxxxxxxx (Maria Lodwich)
  • To: <openbeosmediakit@xxxxxxxxxxxxx>
  • Date: Sat, 24 Nov 2001 14:11:35 +0100

Aleksander Lodwich:
I am doing my documentation in Word97. I think it is a good base line
for everyone.

-----Urspr=FCngliche Nachricht-----
Von: openbeosmediakit-bounce@xxxxxxxxxxxxx
[mailto:openbeosmediakit-bounce@xxxxxxxxxxxxx] Im Auftrag von Jeff Biss
Gesendet: Mittwoch, 21. November 2001 18:20
An: Marcus Overhagen
Cc: openbeosmediakit@xxxxxxxxxxxxx
Betreff: [openbeosmediakit] Re: Media Kit documentation
Wichtigkeit: Hoch

Marcus and all others,

* Gobe format isn't very handy, and doesn't have working links
* HTML would be much better for reference during deveopment
* currently, we are not changing any functionality, so
* there aren't any additions yet.

1. I chose GoBe since it the most robust text editor for use in Be. I
assumed that people on the project had this app. and were going to work
in Be not Windows. I may be wrong. microlimp Word (at least 2000 does)
reads in an HTML file and allows the links and text to be edited.
MacroMedia's DreamWeaver also allows work to be done on the HTML files.
This would mean work is done in a Windows environment. I do not have
experience with HTML editors in Be or (to think of it now) whether
GoBeProductive provides for "Importing" an HTML file that provides for
working directly in HTML with links. I will look into that potential
solution.

So, I need to know if people can use either Word 2000 or DreamWeaver
(with the potential of using Import in GoBeProductive) for their
changes/additions. If this is the case I don't see any purpose in
emailing any BeBook files since the developers can edit the BeBook from
the HTML files directly. This would require the developer to copy the
BeBook on a Windows disk (only their specific sections). Since I have a
dual-boot machine Be can copy the files to the NT disks.

Please bear with me as I look for the best solution to provide HTML and
PDF (the PDF version will be capable of producing on-line and print
documentation).

I would like ALL developers to email me their names and their
responsibilities and available programs. We can then tailor my support
to them as required. So, developers, email me. I will use your responses
to develop a system for all other groups.

* I don't know the exact meaning of markup, "rise a price" doesn't
* seem to be correct :)

2. Mark up means that you physically edit the text. It comes from=20
actually using a pen to mark a paper page with changes. In the case of=20
electronic files you would edit the text as required and I woud edit it=20
for clarity. I forget that people may not use the same jargon.

It appears that I need to wait until I hear from the developers so that=20
I can evaluate the support required. So don't waste time marking up the=20
text files yet.


* we have some undocumented areas (sample code only), as driver
* interfaces etc. these one need better documentation, or newsletter=20
* articles that need to be added to the documentation. Do we have=20
* to do this, or will you be doing it?

3. I will do this. Send me your drafts so that I can edit them. I will=20
send them back for your review to ensure that they are accurate after my

edits. Again, I need to know what program/format you use so I can use=20
the same. I would like to develop a template/style for use with all=20
documentation so that we provide a consistent face to the world. It must

be different from BeOS's so we don't commit a copyright crime.

Sincerely, Jeff Biss


Marcus Overhagen wrote:

>I received an en email by Jeff Biss,
>who is doing documentation for the OpenBeOS.
>
>But I see a few major problems in this.
>* Gobe format isn't very handy, and doesn't have working links
>* HTML would be much better for reference during deveopment
>* currently, we are not changing any functionality, so
>* there aren't any additions yet.
>* I don't know the exact meaning of markup, "rise a price" doesn't
>* seem to be correct :)
>* we have some undocumented areas (sample code only), as driver
>* interfaces etc. these one need better documentation, or newsletter=20
>* articles that need to be added to the documentation. Do we have=20
>* to do this, or will you be doing it?
>
>regards
>Marcus
>
>>Marcus,
>>
>>My name is Jeff Biss and I am converting the existing BeBook for use=20
>>with the OpenBeOS project. I'm [...] able to=20
>>send you the first half that I have completed.
>>
>>I am sending the files in a WinZip file since I am in NT at the moment

>>and have just finished working in FrameMaker in my regular job. The=20
>>files are in GoBeProductive format. Regarding the review/update
process:
>>
>>- The files are conversions directly from the BeBook included in Be
ver. 5
>>- Review only the content for relevance and accuracy. I haven't taken=20
>>the time to figure out how to include graphics in GoBeProductive yet
so=20
>>they are missing.
>>- Do not worry about format. This is a first pass and needs
improvement.
>>- Mark up as you see fit.
>>- I will leave these files on my system as they were sent to you and=20
>>will use your markups when you send them back.
>>- These files will be used to produce a PDF version and HTML so their=20
>>organization will change to make this process easy and maintainable.
>>
>>I need to know what people need, such as what file format.
>>
>>- I have done this in GoBeProductive but that program produces Word=20
>>format files and ultimately I will use FrameMaker to produce the book.

>>From that book the PDF and HTML will be produced. Since most people do

>>not do desktop publishing most do not have FrameMaker so I need to use
a=20
>>program that everyone can use initially.
>>
>[...]
>
>>Sincerely, Jeff Biss
>>Documentation for OpenBeOS
>>
>
>I have uploaded it here: http://beos.overhagen.de/1st half of Media
kit.zip
>=20
>
>
>





Other related posts:

  • » [openbeosmediakit] AW: Re: Media Kit documentation