Re: Cantus 3 documentation

[Samuel Abels <spam debain org>]

Hello,

I have now rewritten the documentation using the "Blackjack" game
documentation as a template. It seems to work, but the behavior is
somewhat different from other documentations (the section browser tree
of the yelp is not visible).

As I mentioned before english is not my native language, so I would be
glad if somebody could check that also.

I did not know how to send the documentation, so I have build a tarball
of the complete program.

http://sam.homeunix.com/cantus_3-3.0-2.tar.gz

The files can also be browsed online:

http://cvs.gna.org/viewcvs/cantus/cantus-3/doc/cantus_3.xml?rev=1.1&content-type=text/vnd.viewcvs-markup
http://cvs.gna.org/viewcvs/cantus/cantus-3/doc/legal.xml?rev=1.1&content-type=text/vnd.viewcvs-markup
http://cvs.gna.org/viewcvs/cantus/cantus-3/doc/figures/cantus_start_window.png

Again, I would appreciate your comments.

-Samuel

On Tue, 2004-04-06 at 19:22, Samuel Abels wrote:
> Sasha,
> 
> Thanks for your reply. I will get back to the list as soon as I have
> made up some more documentation.
> I will try to provide it in the DocBook format then.
> 
> Thanks again,
> -Samuel
> 
> On Tue, 2004-04-06 at 15:10, Alexander Kirillov wrote:
> > No, TeX - much as I like it - is not the correct format for online
> > documentation. The format used by GNOME docs is DocBook 4.1.2 (it takes
> > some time to learn, though). 
> > 
> > I can convert your document into DocBook - this is not hard. It would do
> > for a start. For future use, the manual will need a lot more detail -
> > but I can't help here as I do not have Cantus installed yet. Once I
> > have, I could give you a hand with this. 
> > 
> > Best,
> > Sasha
> > 
> > 
> > On Mon, 2004-04-05 at 05:13, Samuel Abels wrote:
> > > Hello,
> > > 
> > > In preparation of the Cantus 3 final release with closer GNOME
> > > integration I have prepared a simple End User Documentation. Anyway, I
> > > am not a native english speaker, so the result is probably unsatisfying.
> > > 
> > > Talking to the desktop-devel-list for GNOME2.8 preparation I have been
> > > asked to check the documentation with you guys, so I would be happy to
> > > receive your comments.
> > > 
> > > I have appended the documentation as a .tex document; I hope that is the
> > > right format. Please let me know if it is not.
> > > 
> > > The project homepage ist here:
> > > http://www.debain.org/?project=3
> > > 
> > > A second question: Is proper API documentation also required for GNOME
> > > inclusion? In that case, I would appreciate your comments on it also:
> > > 
> > > http://www.debain.org/cantus/cantus3_api.html
> > > 
> > > -Samuel
> > > 
> > > -----------------------------------------------
> > > \documentclass{article}
> > > \title{Cantus 3}
> > > \author{Samuel Abels}
> > > \date{February 2004}
> > > \begin{document}
> > > \maketitle
> > > \tableofcontents
> > > % --------------------------------------------------------------
> > > \section{Indroduction}
> > >   \subsection{What is Cantus?}
> > >   Cantus is an easy to use Tag Editor, primarily made to tag Audio files.
> > >   
> > > % --------------------------------------------------------------
> > > \section{The Mainwindow}
> > >   The mainwindow consists of basicly two elements:
> > >   
> > >   \begin{itemize}
> > >   \item  The filebrowser in the middle of the window, consisting of a directory
> > >          tree on the left side and filelist on the right side.
> > >   \item  The toolarea, on the bottom of the window.
> > >   \end{itemize}
> > >   
> > >   The toolarea can also be shown on the right of the window. Refer to
> > >   \ref{mainwindow:menus}Menus.
> > >   
> > > \subsection{Menus}
> > > \label{mainwindow:menus}
> > >   The "File" menu has currently only one item: "Quit" exits the program
> > >   immidiately.
> > >   
> > >   The "Edit" menu provides "Cut", "Copy" and "Paste" to lets you do clipboard
> > >   operations with any selected text. By clicking on "Preferences", the
> > >   Preferences dialog will be opened.
> > >   
> > >   The "View" menu lets you change the window appearance. You can choose the
> > >   position of the Tools, eighter right or bottom.
> > >   
> > > \subsection{Viewing Tags}
> > >   Use the directory browser in the mainwindow to navigate to the directory
> > >   containing the files you want to view.
> > >   By clicking on the directory the filelist will show your files up.
> > >   If it does not, you might want to look at section \ref{pref:filebrowser}
> > >   File Browser Preferences.
> > >   
> > >   Then, mark the file whose tag you want to view by clicking on it. When you
> > >   do, the pluginarea will show up, showing all informations regarding the tags
> > >   of the chosen file.
> > >   
> > >   Once you have selected a file and the tools have become visible, select a
> > >   tool by clicking on its tab label. For example, click on "ID3V2 Tag" to
> > >   edit the tag fields.
> > >   
> > >   The current tag of the file shows up.
> > >   
> > > \subsection{Writing Tags}
> > >   Once you have opened a file and view the tag in a tool, you can edit its tag
> > >   fields. For example, enter "My superb Artist" in the "Artist" entry box.
> > >   To mark the field for writing, activate the check box right from the entry
> > >   box.
> > >   
> > >   Repeat the above procedure for every field that you want to change.
> > >   
> > >   When ready, click "Save" and the tag will be written to all files that are
> > >   currently selected in the filebrowser.
> > >   All fields that do not have the checkbox activated will be left untouched.
> > >   
> > > \section{Preferences}
> > >   The preferences dialog lets you customize Cantus to fit your needs.
> > >   
> > > \subsection{File Browser Preferences}
> > > \label{pref:filebrowser}
> > >   You can customize the File Browser appearance in this section of the
> > >   preferences dialog.
> > >   
> > >   The "Startup Directory" is the directory that Cantus will open immidiately
> > >   after program startup.
> > >   If the startup directory can not be found, your home directory will be opened.
> > >   If your home directory can not be found, the filesystem root will be opened.
> > >   
> > >   The "Show filetypes" lets you specify all filetypes that you consider being
> > >   of interest for you. You can enter glob-style patterns there. For example,
> > >   to display .ogg files only, enter "*.ogg".
> > >   To display .ogg and .flac files as well, enter "*.ogg,*.flac".
> > >   
> > >   By activating the "Show hidden files" checkbox you indicate Cantus not to
> > >   skip files beginning with a dot (".").
> > >   
> > > % --------------------------------------------------------------
> > > \section{About this Document}
> > > Written by Samuel Abels. Please refer comments to the author.
> > > 
> > > Current Revision: 1.0
> > > \end{document}
> > > 
> > > _______________________________________________
> > > gnome-doc-list mailing list
> > > gnome-doc-list gnome org
> > > http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> > 
> > _______________________________________________
> > gnome-doc-list mailing list
> > gnome-doc-list gnome org
> > http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> > 
-- 
 ------------------------------------------------------
|      Samuel Abels       |   http://www.debain.org    |
| spam ad debain dod org  | knipknap ad jabber dod org |
 ------------------------------------------------------