OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [docbook-apps] How to insert "placeholder" in my documentation



Dave,

I am trying to insert a placeholder for the product name, which would vary
from project to project.

My docbook consists of a book file with a number of chapter and section
files referenced. Can the entity be defined at book file level to affect all
the files it references?  Some of the section files are imported from a
different project during the doc build process (using ant), so we can't set
the entity at individual file level. 

Is there a way of declaring the entity at project level, ie, in the
stylesheet - so that the entity declaration itself is a variable that
depends on the project name? 

We are using dtd 4.1, fop 0.93 and docbook 1.72.0. 
We use ant to build the pdf docs, but we wish to find a solution within
docbook process. 

Best Regards
Akagi





 


Dave Cushman wrote:
> 
> Manuel,
> 
> You can include your .propertie file like so in the header of your  
> main file (the one with <!DOCTYPE ...) :
> 
> <!ENTITY % prop_file SYSTEM ".propertie.xml">  (be sure to make the  
> SYSTEM path correct)
> %prop_file;
> 
> This will then allow you to call for any entity defined in  
> the .propertie file.
> 
> http://www.sagehill.net/docbookxsl/ModularEntities.html
> 
> Dave
> 
> On Mar 22, 2008, at 11:28 AM, Manuel Wallnoefer wrote:
> 
>> Hi Dave !
>>
>> Thx for your quick reply.
>>
>> Yes i think this could help, but there is one problem.
>>
>> My customer name is saved in a .propertie file externally.
>>
>> In my documentation for example i have a file
>>
>> - index.xml
>> - chapter1.xml
>> - chapter2.xml    ... and so on
>>
>> When i now want to use &customer_name in chapter1.xml i must define  
>> the
>> <!ENTITY customer_name "Loves My Product"> in the header of my
>> chapter1.xml , am I right ?
>>
>> If it is so, there is my problem. The .properties file where the
>> customer name is stored is generated right before i convert my docbook
>> files.
>>
>> And so, the line <!ENTITY customer_name "customer name from .propertie
>> file"> has to be generated in a certain way.
>>
>> Do you know what i mean ?
>>
>> And so my question is how to do such things in docbook ?
>>
>> Thanks for your help !
>>
>> ~manuel
>>
>>
>>
>> Dave Cushman wrote:
>>> Manuel,
>>>
>>> It sounds like you are trying to include entities.  For instance, you
>>> would define the entity <!ENTITY customer_name "Loves My Product">,
>>> then call for it in your document with &customer_name;.  When you
>>> convert, anywhere there is a call for &customer_name; the text "Loves
>>> My Product" will appear.  Does this help?
>>>
>>> Dave
>>>
>>>
>>> On Mar 22, 2008, at 9:19 AM, Manuel Wallnoefer wrote:
>>>
>>>> Hi all !
>>>>
>>>> First of all i want to say that i'mnew to dockook. It's cool  
>>>> stuff, now
>>>> i'm working on my master theses and there i have to generate my
>>>> documentation with docbook.
>>>>
>>>> My problem now is, that in my docu , there must be some  
>>>> "placeholder" in
>>>> the text, which are filled with a certain property at compile time.
>>>>
>>>> These variable fields are something like the name of the customer,  
>>>> or
>>>> the logo of the customer and so on ...
>>>>
>>>> I have a .propertie file wher all my variables are stored. Now i  
>>>> have to
>>>> bring them "into" my docbook docu.
>>>>
>>>> A lot of variable things i solved with profiling attributes. But  
>>>> such a
>>>> thing like placeholders i couldn't find up to now.
>>>>
>>>> Whats the best way to do this ?
>>>>
>>>> Thanks for help !
>>>>
>>>> ~manuel
>>>>
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis- 
>>>> open.org
>>>> For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
>>>
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
> 
> 
> 

-- 
View this message in context: http://www.nabble.com/How-to-insert-%22placeholder%22-in-my-documentation-tp16221078p16993184.html
Sent from the docbook apps mailing list archive at Nabble.com.



[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]