A tool for this purpose is in my opinion do not fit, we need
to commit ourselves to doc maintainment, when the code base is changed.
I do not see any good working automation around that, this has to be
done manually to ensure a good documenation.

Gil



Le lundi 10 sept. 2018 à 11:00:11 (+0200), Jacques Le Roux a écrit :
> Makes sense, thanks guys,
> 
> Redundancy is indeed not always bad. But you will have to maintain the 
> consistency between the images, maybe a tool could be built and used?
> 
> Jacques
> 
> 
> Le 10/09/2018 à 09:39, Gil Portenseigne a écrit :
> > Yes that was my intention :), i should have said it so !
> > 
> > Le lundi 10 sept. 2018 à 10:28:24 (+0300), Taher Alkhateeb a écrit :
> > > perhaps you can place a copy of whatever you want in
> > > $OFBIZ_HOME/docs/asciidoc/images/
> > > On Mon, Sep 10, 2018 at 10:22 AM Gil Portenseigne
> > > <[email protected]> wrote:
> > > > Hello Jacques !
> > > > 
> > > > Anytime I see "../../../ ...", i feel like it's a bad design.
> > > > 
> > > > Moreover i think that documentation should be auto-sufficient, and 
> > > > should not be
> > > > code dependant. So a direct reference to theme material in this way
> > > > should be avoided.
> > > > 
> > > > Gil
> > > > 
> > > > 
> > > > Le lundi 10 sept. 2018 à 08:14:14 (+0200), Jacques Le Roux a écrit :
> > > > > Le 07/09/2018 à 16:19, Gil Portenseigne a écrit :
> > > > > > On another hand, i wanted to reference an icon within common-theme, 
> > > > > > i
> > > > > > set the property :
> > > > > > :imagesdir: ../../../../../../themes/common-theme/webapp/images/img/
> > > > > > 
> > > > > > Which is in my opinion a bad choice. I guess it's better to 
> > > > > > duplicate
> > > > > > the image within the documentation tree.
> > > > > Hi Gil,
> > > > > 
> > > > > To enlighten myself, why do you consider it a bad choice?
> > > > > 
> > > > > Jacques
> > > > > 
> 

Reply via email to