Michelle/Sue, 

This is great news a sgml->xml conversion tool is also needed for gnome
help documentation.

Gnome help is written completely in docbook xml, and the view yelp does not
support sgml so some sort of conversion process from solbook 3.1 to docbook
xml is required if we are to ship Sun written help docs.

The previous JDS doc team, used to write solbook 2.2 help docs, and they had
a conversion process/script that they used to generate docbook xml. I've been
having a look at this and so far I cannot recreate the process exactly.

I have located the script they used, s2d.sh, which seems to use xsltproc and 
some stylesheets, and the command "sx", which from what I can see is now called
"s2x" and is shipped as part of opensp.

I would definitely be interested in testing out these new scripts to see if the 
output
generated would be compatible with our gnome help viewer (yelp). Would be really
super cool if it does.

Let me know and I can forward you the s2d.sh script that I have...

Cheers

Matt

>Hi Glynn,
>
>The command Sue mentioned is almost ready, it should be similar in 
>simplicity to sgml2roff. We hope to have a way to test the SGML->XML 
>transformation by end of this week, if not early next week. I'd be 
>thrilled to work with you on testing it for your man pages, so send 
>anything you want to start with. I'm happy to add you as a doc 
>community leader, so you can use the doc pages to upload your content 
>and files, just let me know. Great to have your help!
>
>Regards,
>Michelle
>  
>/X-Original-To: docs-discuss at opensolaris.org 
><http://mail.opensolaris.org/mailman/listinfo/docs-discuss>
/>/Delivered-To: docs-discuss at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>
/>/Date: Wed, 08 Mar 2006 11:01:40 +1300
/>/From: Glynn Foster <Glynn.Foster at Sun.COM 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>>
/>/To: docs-discuss at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>
/>/MIME-version: 1.0
/>/Content-transfer-encoding: 7BIT
/>/Cc: Brian Cameron <Brian.Cameron at Sun.COM 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>>
/>/Subject: [docs-discuss] Manpages - balancing the corporate and 
/community acts
>/X-BeenThere: docs-discuss at opensolaris.org 
><http://mail.opensolaris.org/mailman/listinfo/docs-discuss>
/>/X-Mailman-Version: 2.1.4
/>/List-Id: General documentation discussion and requests to contribute 
/documentation <docs-discuss.opensolaris.org>
>/List-Unsubscribe: 
/<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>,  
<mailto:docs-discuss-request at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>?subject=unsubscribe>
>/List-Archive: <http://mail.opensolaris.org/pipermail/docs-discuss>
/>/List-Post: <mailto:docs-discuss at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>>
/>/List-Help: <mailto:docs-discuss-request at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>?subject=help>
/>/List-Subscribe: 
/<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>, 
<mailto:docs-discuss-request at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>?subject=subscribe>
>/
/>/Hey there,
/>/
/>/For JDS on Solaris 10 we had a rather complete set of manpages, about
/>/350+ in total by my last count. For that process we had a bunch of
/>/developers writing the content, passing it off to a documentation 
/team
>/for them to mark it up in Adept which seems to output to an 
/SGML/Solbook
>/format. For JDS on Linux, we simply ran the sgml2roff convertion 
/tool,
>/stripped out a few sections [ATTRIBUTES mostly] and generated a new 
/set
>/of manpages.
/>/
/>/Pretty straightforward, huh? Now comes the difficult bit. I'm trying 
/to
>/get as many of these manpages pushed into the upstream community.
/>/There's a huge amount of value in the content, and most of it is 
/generic
>/enough for most other distributions [1]. It also makes our lives
/>/infinitely easier if the manpage build infrastructure is coming 
/directly
>/from the community sources. While most of the manpages there are a
/>/straight nroff format, there are some based on docbook with a simple
/>/xsltproc convertion using the manpage stylesheet at build time.
/>/
/>/So I guess I'm looking for some advice - in terms of providing
/>/continuing value to Solaris/OpenSolaris [2], but also in terms of
/>/maintainability etc. I don't think we can feasibly push all the 
/manpages
>/upstream if it's based on Sun's sgml format because those tools 
/aren't
>/readily available - however, if we can find a common ground, it'll
/>/certainly prove easier for us in the future.
/>/
/>/
/>/thanks,
/>/
/>/Glynn
/>/
/>/[1] With the exception probably being Debian who already have a 
/manpage
>/    policy
/>/[2] And I'd certainly welcome someone explaining the differences 
/between
>/    sgml and nroff
/>/
/>/_______________________________________________
/>/docs-discuss mailing list
/>/docs-discuss at opensolaris.org 
<http://mail.opensolaris.org/mailman/listinfo/docs-discuss>
/


Reply via email to