[Scilab-users] no "%" in xml:id of help pages <= Re: unit tests and help generation for overloaded unary/binary operators

[Samuel Gougeon]

Le 18/06/2016 11:53, philippe a écrit :
> Le 16/06/2016 19:46, Samuel Gougeon a écrit :
>> Hello Philippe,
>>
>> AFAIR, XML filenames must not have the "%" character. Moreover, xml ids
>> must exclude it as well.
> Ok, so I've added to my build_help.sce file the lines
>
> %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
> for fic=listfiles(help_lang_dir+'%bigint_*.xml')'
> newfic=strsubst(fic,'%','')
> printf('%s \n to \n %s\n',fic,newfic)
> unix(' mv '+fic+' '+newfic)
> end
> %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
>
>> So, if the xml id of the page is currently "%bigint_o_bigint", you
>> should rather choose something like "bigint_equal_bigint" instead.
> I also removed the % in *.xml help files using the following lines :
>
> %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
> for fic=listfiles(help_lang_dir+'*.xml')'
> unix('sed -i ''s/%bigint_/bigint_/g'' '+fic)
> end
> %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
>
> I don't know if i can do this without using bash command so that anyone
> can build the toolbox even on windows system ? Any the way this is not
> very important since the toolbox only contains only scilab macros (no
> gateway needed ).
>
>> help generation and unit tests are completely independent from each other.
> yes but for maintainability it's easier if unit tests of myfunction.sci
> is stored in myfunction.tst :-)
>
> Know it works fine , Thanks a lot Samuel!
Great. Thanks for the feedback.
I don't know why exactly the "%" is avoided or even excluded in any 
xml:id (so just in the <refentry ... xml:id=""> entry/attribute). The 
contents of XML files may include some "%" without any problem, but not 
the xml:id. It could be due to some restrictions for HTML pages and 
search engines over pages.
The Windows files manager accepts "%" in files name without any problem, 
but AFAIK the basename of scilab XML files is chosen equal to the (main) 
xml:id of the help page.

Samuel
(Happy to see you back on the mailing lists :)