Account Options

  1. Sign in
The old Google Groups will be going away soon, but your browser is incompatible with the new version.
Google Groups Home
« Groups Home
Message from discussion AsciiDoc is suitable for complex documents like manuals and books
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Andy68  
View profile  
 More options Feb 20 2009, 2:07 pm
From: Andy68 <andy.jew...@gmail.com>
Date: Fri, 20 Feb 2009 11:07:10 -0800 (PST)
Local: Fri, Feb 20 2009 2:07 pm
Subject: Re: AsciiDoc is suitable for complex documents like manuals and books
Great, thanks, Henrik.  Last question. . :)  For the final document,
do you piece it together manually
or do you have another top level document that includes chapters in
the same way your chapters included textblocks?

e.g.,

Device FOO Manual
=================
include::{incdir}/chapter1-installation.txt[]
include::{incdir}/chapter2-usage.txt[]
include::{incdir}/chapter3-troubleshooting.txt[]

Many thanks!

-Andy

On Feb 20, 5:19 am, Henrik <hwma...@gmail.com> wrote:

> On Feb 20, 9:02 am, Andy68 <andy.jew...@gmail.com> wrote:

> > Would you mind sharing how you organize the source documents?  Is it
> > all in one document or do you have them split up in a hierarchy?  I do

> I have one main document and a large set of subdocuments which I call
> "textblocks". This is very similar to a program which uses subroutines
> in a library. The "textblocks" are reusable components which are used
> in several manuals. For example the description of a RS-232 port pin-
> out is used in several manuals or another example would be the usual
> safety regulations which are repeated in every manual. Referring to
> the manual posted earlier, the chapter Installation in the main
> document looks like:

> Installation
> ------------
> include::{incdir}/safety_precautions.txt[]
> include::{incdir}/regulatory_notes.txt[]
> include::{incdir}/unpacking_handling.txt[]
> include::{incdir}/before_connecting.txt[]
> include::{incdir}/xnut_mounting.txt[]
> include::{incdir}/mounting_rules.txt[]

> I even use AsciiDoc attributes to parametrize some of the included
> textblocks, similar to passing parameters to a function in a
> programming language.

> Hope that explains a bit the concept. It allows me to quickly create
> new manuals with little overhead and also to maintain common text
> sections across several product manuals.

> Henrik


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.