This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: Re: DocBook markup and possibly a RFE. --- One more! ;-)


Norman Walsh <ndw@nwalsh.com> writes:

> / godoy@conectiva.com.br was heard to say:
> [...]
> | I'm having problems marking up some network items which I don't know
> | what tag I could use:
> 
> What is your motivation for tagging these items? For searching,
> indexing, or something else? (I'm just curious.)

We're doing some technical analisys (like some hardware certification
--- I mean, we're telling people that their hardware is fully
compatible with our Linux distribution), and also writing things like
installation guides, training on network issues and things like that. 

Indexing and searching is another reason.

We're planning on developing an online feedback system for books and
booklets that we write and we'll be trying to get the text directly
from the sources instead of asking for the customer to type it.

> | 1. IP addresses and host names (e.g. 10.0.0.2 and lists.oasis-open.org)
> 
> <systemitem class="systemname">?

It's ok. I haven't seen this class when I've looked through the docs. 

> | 2. Network protocols (e.g. PPP, TCP/IP)
> 
> <acronym>?

I don't know if it will fit all the time. I think that on a book about
networks it would be _very_ ugly to mark up all these protocols
ocorrences as <acronym>. Other <acronym>s that might occur next to
them may be obfuscated or misinterpreted. 

> | 3. Filesystem type (e.g. VFAT, EXT2, UFS, NTFS) 
> 
> Hmmm...

Couldn't this be something like <systemitem class="filesystem">? 

> | 4. Disk partition (e.g. the first partition of a SCSI disk on a linux
> |                    system should be /dev/sda1)
> 
> <filename class="devicefile">?

It would be ok. 

> | 5. Program names (not filenames or application names) for marking up
> |    programs such as "grep". 
> 
> <command>?

Nope. <command> would be used when talking the what is the command to
run the program grep. 

> | 6. Network interface (e.g. slip0, ppp0, eth0)
> 
> Hmmm...

<systemitem class="networkinterface">? 

Thanks,
-- 
Godoy.	<godoy@conectiva.com> 

Departamento de Publicações
Publishing Department                   Conectiva S.A.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]