[publican-list] I'm quite lost
Chris Sederqvist
c.sederqvist at gmail.com
Thu Aug 4 00:45:44 UTC 2011
Thanks alot for all the helpful tips and links!
I guess it's time to study now... :-)
One more thing:
When I'm replying to a list, is this the right way to do it?
I choose "reply to group" and start writing at the top?
Sorry, but I'm all new to this collaboration stuff :\
On Wed, 2011-08-03 at 12:00 -0400, publican-list-request at redhat.com
wrote:
> Send publican-list mailing list submissions to
> publican-list at redhat.com
>
> To subscribe or unsubscribe via the World Wide Web, visit
> https://www.redhat.com/mailman/listinfo/publican-list
> or, via email, send a message with subject or body 'help' to
> publican-list-request at redhat.com
>
> You can reach the person managing the list at
> publican-list-owner at redhat.com
>
> When replying, please edit your Subject line so it is more specific
> than "Re: Contents of publican-list digest..."
>
>
> Today's Topics:
>
> 1. I'm quite lost... (Chris Sederqvist)
> 2. Re: I'm quite lost... (Misty Stanley-Jones)
> 3. [Bug 727756] New: Watermarks no workie. (bugzilla at redhat.com)
> 4. Re: I'm quite lost... (Norman Dunbar)
>
>
> ----------------------------------------------------------------------
>
> Message: 1
> Date: Tue, 02 Aug 2011 18:49:55 +0200
> From: Chris Sederqvist <c.sederqvist at gmail.com>
> To: publican-list at redhat.com
> Subject: [publican-list] I'm quite lost...
> Message-ID: <1312303802.5703.12.camel at thermoz.localhost>
> Content-Type: text/plain; charset="utf-8"
>
> Hello.
>
> I've volunteered to write for fedora-docs, but I have no idea as in how
> to use the tools to actually produce the documentation!
> I understand that I must learn some Docbook, but what version, what
> parts and how much of it?
> Then it is the Publican tool. Does anybody know of a good screencast or
> something to get me going with this tool?
>
> This might not be the right place to post this. If not, please guide me
> to the correct place.
>
> All the best
>
> Chris
> -------------- next part --------------
> A non-text attachment was scrubbed...
> Name: cs_public_key.asc
> Type: application/pgp-keys
> Size: 1760 bytes
> Desc: not available
> URL: <https://www.redhat.com/archives/publican-list/attachments/20110802/9de116ba/attachment.bin>
>
> ------------------------------
>
> Message: 2
> Date: Tue, 2 Aug 2011 18:01:14 -0400 (EDT)
> From: Misty Stanley-Jones <misty at redhat.com>
> To: Publican discussions <publican-list at redhat.com>
> Subject: Re: [publican-list] I'm quite lost...
> Message-ID:
> <510146813.776965.1312322474227.JavaMail.root at zmail02.collab.prod.int.phx2.redhat.com>
>
> Content-Type: text/plain; charset=utf-8
>
> Hi Chris,
>
> First of all, thank you for volunteering!
>
> Second, here are some good resources to get you started with Publican and Docbook:
>
> Publican User Guide - http://rlandmann.fedorapeople.org/pug/ - This will guide you through installing Publican on your computer and starting to write Docbook. It includes some basic information about syntax, to get you started.
>
> Docbook reference - http://www.docbook.org/tdg/en/html/ref-elements.html - I have linked you directly to the list of Docbook elements. You can click each element and see examples and usage guidelines. You can back out to read the entire book if you like, but you don't really need to read it to get started.
>
> One of the first decisions to make is which editor to use. Since Docbook uses structured XML, you can use any text editor. Some of them offer extra features to make things go faster. I use Emacs to edit Docbook, but I am in the extreme minority. Most of my colleagues seem to use GEdit, kwrite, Kate, Jedit, or Geany. There are also some open source GUI editors, such as Serna (http://www.syntext.com/products/serna-free/), if that is your kind of thing.
>
> This is definitely the right place to ask, so if you have more questions, please ask away!
>
> Thanks,
> Misty
>
>
> ----- Original Message -----
> > From: "Chris Sederqvist" <c.sederqvist at gmail.com>
> > To: publican-list at redhat.com
> > Sent: Wednesday, August 3, 2011 2:49:55 AM
> > Subject: [publican-list] I'm quite lost...
> > Hello.
> >
> > I've volunteered to write for fedora-docs, but I have no idea as in
> > how
> > to use the tools to actually produce the documentation!
> > I understand that I must learn some Docbook, but what version, what
> > parts and how much of it?
> > Then it is the Publican tool. Does anybody know of a good screencast
> > or
> > something to get me going with this tool?
> >
> > This might not be the right place to post this. If not, please guide
> > me
> > to the correct place.
> >
> > All the best
> >
> > Chris
> >
> > _______________________________________________
> > publican-list mailing list
> > publican-list at redhat.com
> > https://www.redhat.com/mailman/listinfo/publican-list
> > Wiki: https://fedorahosted.org/publican
>
> --
>
>
> Misty Stanley-Jones, RHCE
> Content Author, ECS Brisbane
> ?: misty (Freenode IRC) ?: misty at redhat.com
>
>
>
> ------------------------------
>
> Message: 3
> Date: Wed, 3 Aug 2011 02:33:15 -0400
> From: bugzilla at redhat.com
> To: publican-list at redhat.com
> Subject: [publican-list] [Bug 727756] New: Watermarks no workie.
> Message-ID: <bug-727756-264938 at bugzilla.redhat.com>
> Content-Type: text/plain; charset="UTF-8"
>
> Please do not reply directly to this email. All additional
> comments should be made in the comments box of this bug.
>
> Summary: Watermarks no workie.
>
> https://bugzilla.redhat.com/show_bug.cgi?id=727756
>
> Summary: Watermarks no workie.
> Product: Publican
> Version: 2.6
> Platform: Unspecified
> OS/Version: Unspecified
> Status: NEW
> Severity: unspecified
> Priority: unspecified
> Component: publican
> AssignedTo: jfearn at redhat.com
> ReportedBy: sgordon at redhat.com
> QAContact: rlandman at redhat.com
> CC: mmcallis at redhat.com, publican-list at redhat.com
> Classification: Other
> Story Points: ---
> Type: ---
>
>
> Description of problem:
>
> When building a book with the status="draft" attribute set on the book tag, the
> watermark no longer appears in the output.
>
> Version-Release number of selected component (if applicable):
>
> publican-redhat-2.7-2.fc15.noarch
> publican-2.6-1.fc15.noarch
>
> Steps to Reproduce:
> 1. Create a book.
> 2. Set the status attribute of the book tag to draft.
> 3. Build (affects pdf, html, html-single output formats at least).
>
> Actual results:
>
> No draft watermark in output.
>
> Expected results:
>
> Draft watermark in output.
>
> --
> Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
> ------- You are receiving this mail because: -------
> You are on the CC list for the bug.
>
>
>
> ------------------------------
>
> Message: 4
> Date: Wed, 03 Aug 2011 08:13:48 +0100
> From: Norman Dunbar <Norman at dunbar-it.co.uk>
> To: publican-list at redhat.com
> Subject: Re: [publican-list] I'm quite lost...
> Message-ID: <4E38F52C.9060403 at dunbar-it.co.uk>
> Content-Type: text/plain; charset=UTF-8; format=flowed
>
> Good Morning Chris,
>
> > I've volunteered to write for fedora-docs,
> Good man! Even though I'm not a Fedora user, I do appreciate all the
> hard work volunteers put in to make it a great product.
>
> > but I have no idea as in how to use the tools to actually produce the documentation!
> Ah yes, how I remember when I first started writing Docbook
> documentation for the Firebird Database project (www.firebirdsql.org) -
> I too had no clue and I found that trying to find a good beginner's
> guide to Docbook was quite difficult back then.
>
> > I understand that I must learn some Docbook, but what version, what
> > parts and how much of it?
> I suspect you will be learning Docbook 4.5 or maybe even 5.x - but they
> are, to all intents and purposes, quite similar. Best check what the
> rest of the Fedora docs are using - I suspect 4.5 to be honest.
>
> > Then it is the Publican tool. Does anybody know of a good screencast or
> > something to get me going with this tool?
> I'm afraid not. The User Guide is quite good, but isn't really a
> tutorial. In fact, when I have time, I intend to create a small tutorial
> mainly for my own use - I'm getting old, I forget stuff :-( - which I
> will make freely available (if it's any good of course!)
>
> Now, I'm sure the Publican people won't mind me pointing you off
> project, but why not take a look at the documents for documentation
> writers over at the Firebird project. Granted they will be aimed at that
> particular style of documentation, but you will get a general
> introduction to Docbook.
>
> Try these links:
>
> The main documentation site:
>
> http://www.firebirdsql.org/en/reference-manuals/ scroll down to the
> section on "Manuals For Firebird Docwriters".
>
>
> How To Write DocBook:
>
> ONLINE:
> http://www.firebirdsql.org/file/documentation/reference_manuals/user_manuals/html/docwritehowto.html
>
> PDF:
> http://www.firebirdsql.org/file/documentation/reference_manuals/user_manuals/Firebird-Docwriting-Guide.pdf
>
>
> These should be read in conjunction with the links to other docs that
> you have been given already by Misty. (Although the link given for the
> user guide takes you to release 1.3 - I think 2.5 is actually the latest
> available release. (2.6 is the very latest release but I don't think
> it's packaged up for Fedora yet - I may be wrong!)
>
> The 2.5 user guide for Publican is at
> http://jfearn.fedorapeople.org/en-US/Publican/index.html select the
> required version on the left and click on the appropriate link for the
> particular format you want (under User Guide) - you have the choice of
> epub, html, html-single or pdf. Enjoy!
>
> I printed out my guide and read it a few times through away from the
> computer (in the bath!) before I tried to do anything with it.
>
>
> As for an editor, I've tried and failed to like Serna. That's just me.
>
> I tend to prefer using any text editor I have around - Kate, Kwrite or
> vi[m] on a KDE system, Gedit or vi[m] on Gnome. Emacs probably has a
> Docbook setup, but that's another editor I cannot get my head around!
>
> For a GUI, I always seem to return to XML Mind Editor aka XXE. This is
> available in a paid for and a free version. For Open Source
> documentation writers, the free version is adequate and available at
> http://www.xmlmind.com/xmleditor/download.shtml.
>
> There is support, via a members only list which you can join at
> http://www.xmlmind.com/mailman/listinfo/xmleditor-support - although
> they do like you to read the FAQ -
> http://www.xmlmind.com/xmleditor/faq.html - before asking! ;-)
>
> One last thing for now, Docbook will drive you insane at first! It's
> extremely frustrating indeed - well I found it so - but eventually, it
> will click. The fact that you can generate multiple output formats from
> one single input file is extremely useful - especially when you have to
> update something! You only do it once.
>
> One thing I'd suggest, keep your source files in a version control
> system - I use Subversion - because when you make changes and then
> decide it's all pants and want to undo them, it's simple with a version
> control taking care of the reversions! My sources live in one folder,
> and are version controlled to another - on the same laptop. I have found
> it extremely useful indeed, plus, it saves a whole lot of time.
>
> Good luck.
>
>
> Cheers,
> Norman.
>
> PS. I've found everyone on this list to be very helpful, even though
> they know I'm not a Fedora user! I did try Fedora, 14 was pretty good I
> have to say, 15 and Gnome 3, I just don't like at all. Luddite? Me? ;-)
>
More information about the publican-list
mailing list