[Fwd: Re: [Fwd: Re: Proposal for Implementing a Docbook Editor]]

[Ruediger Landmann]

-------- Original Message --------
Subject: 	Re: [Fwd: Re: Proposal for Implementing a Docbook Editor]
Date: 	Thu, 21 May 2009 11:20:26 +1000
From: 	Lana Brindley <lbrindle(a)redhat.com&gt;
Organization: 	Red Hat Asia-Pacific
To: 	Christopher Curran <ccurran(a)redhat.com&gt;
CC: 	Joshua Wulf <jwulf(a)redhat.com&gt;, content-services-staff(a)redhat.com
References: 	<4A14A4D0.40207(a)redhat.com&gt; <4A14A6E1.6040702(a)redhat.com&gt; 
<4A14AB88.7060903(a)redhat.com&gt;



Christopher Curran wrote:
>  Lana Brindley wrote:
> > Joshua Wulf wrote:
> >> Satya is doing a WYSIWYG docbook editor as a Google SOC project in 
> >> Fedora. He wants feedback on what tags to provide support for. Please 
> >> take a look at this list and give some feedback on tags that we use 
> >> that are not covered in it.
> >>
> >> - Josh
> >>
> >> -------- Original Message --------
> >> Subject:     Re: Proposal for Implementing a Docbook Editor
> >> Date:     Wed, 20 May 2009 21:47:25 +0530
> >> From:     satya komaragiri <satya.komaragiri(a)gmail.com&gt;
> >> Reply-To:     For participants of the Documentation Project 
> >> <fedora-docs-list(a)redhat.com&gt;
> >> To:     For participants of the Documentation Project 
> >> <fedora-docs-list(a)redhat.com&gt;
> >>
> >>
> >>
> >> Hello,
> >>
> >> I have narrowed down to the following set of tags as the minimum that
> >> Docbook editor will need to support for the initial stages of the
> >> project. It would be great if the list could review them once and
> >> suggest any additions/deletions.
> >>
> >>
> >> tags:
> >>
> >> Top Level:
> >> <article id="ID">
> >> </article>
> >>
> >>
> >>
> >> Section:
> >> <section id="ID">
> >>    <title></title>
> >> </section>
> >>
> >>
> >>
> >> Block Tags:
> >> <para></para>
> >> <screen></screen>
> > <programlisting></programlisting>
> >>
> >> <itemizedlist>
> > <title></title>
> >>    <listitem>
> >>        <para></para>
> >>    </listitem>
> >> </itemizedlist>
> >>
> >> <orderedlist>
> > <title></title>
> >>    <listitem>
> >>        <para></para>
> >>    </listitem>
> >> <orderedlist>
> >>
> >> <procedure>
> >>    <step>
> >>        <para>
> >>        </para>
> >>    </step>
> >> </procedure>
> >>
> >> <important>
> >>
> >>    <title></title>
> >>    <para></para>
> >> </important>
> >>
> >> <tip>
> >>    <title></title>
> >>    <para></para>
> >> </tip>
> >>
> >> <note>
> >>    <title></title>
> >>    <para></para>
> >> </note>
> >>
> >> <warning>
> >>    <title></title>
> >>    <para></para>
> >> </warning>
> >>
> >> <caution>
> >>    <title></title>
> >>    <para></para>
> >>
> >> </caution>
> >>
> >>
> >>
> >>
> >> Inline:
> >>
> >> <firstterm></firstterm>
> >> <application></application>
> >>
> >>
> >> <command>
> >>    <option></option>
> >>
> >> </command>
> >>
> >> <package></package>
> >> <filename></filename>
> >> <systemitem></systemitem>
> >> <computeroutput></computeroutput>
> >
> > Is this tag the same as <programlisting>? I don't know it.
> >
>  programlisting is for a block of preformatted code. computeroutput is 
>  for a single inline output snippet. 
Ah-ha! Thanks Chris :)

> >> <userinput></userinput>
> >>
> >> <prompt></prompt>
> >>
> >>
> >> <menuchoice>
> >>    <guimenu></guimenu>
> >>    <guisubmenu></guisubmenu>
> >>    <guimenuitem></guimenuitem>
> >> </menuchoice>
> >>
> >> <guibutton></guibutton>
> >> <guiicon></guiicon>
> >> <guilabel></guilabel>
> >>
> >> <mousebutton></mousebutton>
> >>
> >> <keycombo>
> >>    <keycap></keycap>
> >> </keycombo>
> >>
> >> <abbrev></abbrev>
> >> <acronym></acronym>
> >
> > <abbrev> and <acronym> could both possibly be dropped
> >
>  and in there place firstterm should be added. 
It's in, scroll up.

> >> <emphasis></emphasis>
> >>
> >> <quote></quote>
> >>
> >> <link></link>
> >>
> >> <subscript></subscript>
> >> <superscript></superscript>
> >>
> >>
> >> <action>
> >>
> >> <classname>
> >> <constant>
> >>
> >> <errorcode></errorcode>
> >> <errorname></errorname>
> >> <errortype></errortype>
> >>
> >> <function></function>
> >> <interface></interface>
> >> <parameter></parameter>
> >> <property></property>
> >> <replaceable></replaceable>
> >> <returnvalue></returnvalue>
> >> <structfield><structfield>
> >> <structname></structname>
> >> <symbol></symbol>
> >> <token></token>
> >> <type></type>
> >> <varname></varname>
> > <remark></remark>
> >
> > Also, support for <!--comments-->
> >>
> >>
> >> Regards,
> >> Satya
> >>
> >
>  The only one I would say is seglist should be in the list of advanced 
>  features to implement :) 
Actually, that reminds me of <variablelist>, which I use a lot:

<variablelist>
<title></title>
<varlistentry>
<term></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>

>  
>  I wonder why I didn't get the fedora-docs-list email about this...
>  
>  
>  Chris
>   
L

[satya komaragiri]

Hello,

On Thu, May 21, 2009 at 7:14 AM, Ruediger Landmann
<r.landmann(a)redhat.com&gt; wrote:
[...]
>  Hi Satya!
>
>  A few more that I use very regularly or see very regularly in Red Hat and
>  Fedora docs: 
[...]

It might be tough to support some of these initially. Others should be
easier to implement. Meta elements are tougher to implement because
they are not easy to wysiwyg-ify. Cross referencing,
appendices, indexing are more complex. I'll get down to them after the
basic editing is in place.

>  The article, itemizedlist and orderedlist tags should also support
> <title>
>  tags under them. 
Yes, I forgot to mention them in the list. Will do.

>  At this early stage, I assume that you want to avoid
> <example>s, <figure>s
>  and <table>s, but of course, we make a lot of use of these as well... 
That is indeed the plan. I can get <figure> in more easily though. It
depends on what the editor supports for now as well.

On Thu, May 21, 2009 at 9:08 AM, Ruediger Landmann
<r.landmann(a)redhat.com&gt; wrote:
[more tags ^_^]
>  <remark></remark> 
Adding to list.

>  Also, support for <!--comments--> 
This is another tough one as comments are not really visible. For now
users should be able to edit them directly in SourceView feature.

>  Good luck with the project!
>
>  Cheers
>  Ruediger 
Thanks for the valuable feedback. I'll add this to the suggested wiki
page and then it'll be easier to collaborate. :)

Regards,
Satya

[Ruediger Landmann]

satya komaragiri wrote:
>  Thanks for the valuable feedback. I'll add this to the suggested
> wiki
>  page and then it'll be easier to collaborate. :)
>
>     
Thanks Satya -

once the wiki page is up and running, you might also like to alert Red 
Hat Engineering Content Services -- this is the department where the 
documentation gets written. You can get the address from the CC on this 
email.

Cheers
Ruediger

[sankarshan]

On Fri, May 22, 2009 at 3:56 AM, Ruediger Landmann
<r.landmann(a)redhat.com&gt; wrote:

>  once the wiki page is up and running, you might also like to alert
> Red Hat
>  Engineering Content Services -- this is the department where the
>  documentation gets written. You can get the address from the CC on this
>  email. 
I have my doubts about whether that is an external list - I can't see
that listed off <https://www.redhat.com/mailman/listinfo/>

-- 
http://www.gutenberg.net - Fine literature digitally re-published
http://www.plos.org - Public Library of Science
http://www.creativecommons.org - Flexible copyright for creative work


Sent from Pune, MH, India