Home » Eclipse Projects » Eclipse Platform » <toc label=".."> with <anchor> and <link_to>
| <toc label=".."> with <anchor> and <link_to> [message #144058] |
Tue, 14 October 2003 18:38  |
Eclipse User |
|
|
|
Originally posted by: dcramer.motive.com
If I have two plugins and do the following, I'll end up with:
Test wrapper
Intefaces
File List
foo.h
foo.idl
...
Intefaces
File List
bar.h
bar.idl
...
Instead, I want to have the following:
Test wrapper
The foo component api documentation
Intefaces
File List
foo.h
foo.idl
...
The bar component api documentation
Intefaces
File List
bar.h
bar.idl
...
I would prefer NOT to put a extra topic element in the tocs like so: <toc
label="The foo component api documentation"
link_to="/testwrapper/toc.xml#anchor_id"><topic label="The foo component
api documentation"><topic href="index.html" label="Interfaces"/>...
because I may also want to use this plugins in contexts where I make the
toc top down, and it would create an unneeded toc level.
Is that possible?
Thanks,
David
toc.xml for wrapper:
======================================
<?xml version="1.0" encoding="utf-8"?>
<toc label="Test wrapper">
<anchor id="anchor_id"/>
</toc>
toc.xml for item in wrapper:
======================================
<toc label="The foo component api documentation"
link_to="/testwrapper/toc.xml#anchor_id">
<topic href="index.html" label="Interfaces"/>
<topic href="files.html" label="File List">
<topic href="foo.h.html" label="foo.h"/>
<topic href="foo.idl.html" label="foo.idl"/>
</topic>
<!-- lots of other topics here -->
</toc>
toc.xml for another item in wrapper:
======================================
<toc label="The bar component api documentation"
link_to="/testwrapper/toc.xml#anchor_id">
<topic href="index.html" label="Interfaces"/>
<topic href="files.html" label="File List">
<topic href="bar.h.html" label="bar.h"/>
<topic href="foo.idl.html" label="foo.idl"/>
</topic>
<!-- lots of other topics here -->
</toc>
|
|
| |
| Re: <toc label=".."> with <anchor> and <link_to> [message #146001 is a reply to message #144378] |
Fri, 17 October 2003 20:30  |
| Eclipse User |
|
|
|
Originally posted by: dcramer.motive.com
In this case, I want to have a single <anchor> that receives many plugins.
The
toc.xml for wrapper:
======================================
<?xml version="1.0" encoding="utf-8"?>
<toc label="Big Book of Components">
<topic label="High level overview of components" href="overviewpt1.html>
<!-- Lots of topics in here -->
<!-- providing high level overview of the system -->
</topic>
<topic label="Component Documentation">
<anchor id="anchor_id"/>
<!-- A large (indeterminant) number of components' api docs point to
this single anchor point. I wanted to avoid repeating the label for each
one here because the label is already definined in each plugin's toc,
which is generated by a api doc generating tool at build time. -->
</topic>
</toc>
I get the impression that it is atypical or outside the bounds of the way
the toc was designed. I think it's good that you can define the label that
an included toc receives (as the current system allows), but if you are
content to use the label on the <toc> element in that toc, it would be
nice to be able to do so. Does what I'm trying to do make sense? I realize
that I'm having trouble articulating it.
Thanks,
David
Konrad Kolosowski wrote:
> It is not clear which plug-in or TOCs you want to reuse. Assuming you want
> to reuse TOCs for items, and not the wrapper, you can put the extra topic
> level into the wrapper TOC as in:
> toc.xml for wrapper:
> ======================================
> <?xml version="1.0" encoding="utf-8"?>
> <toc label="Test wrapper">
> <topic label="The foo component api documentation">
> <anchor id="anchor_id1"/>
> </topic>
> <topic label="The bar component api documentation">
> <anchor id="anchor_id2"/>
> </topic>
> </toc>
> If you wanted to reuse all three TOCs in different scenarios, you could
> introduce a fourth TOC, that would act as a glue just for this scenario.
> The TOC can contain the extra topic level and link to wrapper TOC on one
> side and item TOCs on another.
> Konrad Kolosowski
> "David Cramer" <dcramer@motive.com> wrote in message
> news:bmhfrh$6p4$1@eclipse.org...
> > If I have two plugins and do the following, I'll end up with:
> >
> > Test wrapper
> > Intefaces
> > File List
> > foo.h
> > foo.idl
> > ...
> > Intefaces
> > File List
> > bar.h
> > bar.idl
> > ...
> >
> > Instead, I want to have the following:
> >
> > Test wrapper
> > The foo component api documentation
> > Intefaces
> > File List
> > foo.h
> > foo.idl
> > ...
> > The bar component api documentation
> > Intefaces
> > File List
> > bar.h
> > bar.idl
> > ...
> >
> > I would prefer NOT to put a extra topic element in the tocs like so: <toc
> > label="The foo component api documentation"
> > link_to="/testwrapper/toc.xml#anchor_id"><topic label="The foo component
> > api documentation"><topic href="index.html" label="Interfaces"/>...
> > because I may also want to use this plugins in contexts where I make the
> > toc top down, and it would create an unneeded toc level.
> >
> > Is that possible?
> > Thanks,
> > David
> >
> > toc.xml for wrapper:
> > ======================================
> > <?xml version="1.0" encoding="utf-8"?>
> > <toc label="Test wrapper">
> > <anchor id="anchor_id"/>
> > </toc>
> >
> > toc.xml for item in wrapper:
> > ======================================
> > <toc label="The foo component api documentation"
> > link_to="/testwrapper/toc.xml#anchor_id">
> > <topic href="index.html" label="Interfaces"/>
> > <topic href="files.html" label="File List">
> > <topic href="foo.h.html" label="foo.h"/>
> > <topic href="foo.idl.html" label="foo.idl"/>
> > </topic>
> > <!-- lots of other topics here -->
> > </toc>
> >
> > toc.xml for another item in wrapper:
> > ======================================
> > <toc label="The bar component api documentation"
> > link_to="/testwrapper/toc.xml#anchor_id">
> > <topic href="index.html" label="Interfaces"/>
> > <topic href="files.html" label="File List">
> > <topic href="bar.h.html" label="bar.h"/>
> > <topic href="foo.idl.html" label="foo.idl"/>
> > </topic>
> > <!-- lots of other topics here -->
> > </toc>
> >
|
|
|
| Re: <toc label=".."> with <anchor> and <link_to> [message #147431 is a reply to message #146001] |
Tue, 21 October 2003 19:25 |
 Konrad Kolosowski
Messages: 243
Registered: July 2009 |
Senior Member |
|
|
toc.xml for wrapper (primary), in a product:
======================================
<?xml version="1.0" encoding="utf-8"?>
<toc label="Big Book of Components">
<topic label="High level overview of components" href="overviewpt1.html>
<!-- Lots of topics in here -->
<!-- providing high level overview of the system -->
</topic>
<topic label="Component Documentation">
<anchor id="anchor_id"/>
</topic>
</toc>
footoc.xml for wrapper (primary), in a product that has toc.xml, but will
work separately as well:
======================================
<?xml version="1.0" encoding="utf-8"?>
<toc label="Foo Component Documentation">
<!-- Lots of topics in here -->
</toc>
footocglue.xml for wrapper (NOT primary), shipped always together with
footoc.xml, will not do anything if toc.xml not present:
======================================
<?xml version="1.0" encoding="utf-8"?>
<toc label="Foo Component Documentation Glue"
link_to="/wrapper/toc.xml#anchor_id" >
<topic label="Foo Component API Documentation">
<link href="tocfoo.xml" />
</topic>
</toc>
Will not footocglue.xml do what you need? It ads a topic level only when
you need it.
Konrad Kolosowski
"David Cramer" <dcramer@motive.com> wrote in message
news:bmpjh0$mof$1@eclipse.org...
> In this case, I want to have a single <anchor> that receives many plugins.
> The
>
> toc.xml for wrapper:
> ======================================
> <?xml version="1.0" encoding="utf-8"?>
> <toc label="Big Book of Components">
> <topic label="High level overview of components" href="overviewpt1.html>
> <!-- Lots of topics in here -->
> <!-- providing high level overview of the system -->
> </topic>
> <topic label="Component Documentation">
> <anchor id="anchor_id"/>
> <!-- A large (indeterminant) number of components' api docs point to
> this single anchor point. I wanted to avoid repeating the label for each
> one here because the label is already definined in each plugin's toc,
> which is generated by a api doc generating tool at build time. -->
> </topic>
> </toc>
>
> I get the impression that it is atypical or outside the bounds of the way
> the toc was designed. I think it's good that you can define the label that
> an included toc receives (as the current system allows), but if you are
> content to use the label on the <toc> element in that toc, it would be
> nice to be able to do so. Does what I'm trying to do make sense? I realize
> that I'm having trouble articulating it.
>
> Thanks,
> David
>
>
> Konrad Kolosowski wrote:
>
> > It is not clear which plug-in or TOCs you want to reuse. Assuming you
want
> > to reuse TOCs for items, and not the wrapper, you can put the extra
topic
> > level into the wrapper TOC as in:
>
> > toc.xml for wrapper:
> > ======================================
> > <?xml version="1.0" encoding="utf-8"?>
> > <toc label="Test wrapper">
> > <topic label="The foo component api documentation">
> > <anchor id="anchor_id1"/>
> > </topic>
> > <topic label="The bar component api documentation">
> > <anchor id="anchor_id2"/>
> > </topic>
> > </toc>
>
> > If you wanted to reuse all three TOCs in different scenarios, you could
> > introduce a fourth TOC, that would act as a glue just for this scenario.
> > The TOC can contain the extra topic level and link to wrapper TOC on one
> > side and item TOCs on another.
>
> > Konrad Kolosowski
>
>
> > "David Cramer" <dcramer@motive.com> wrote in message
> > news:bmhfrh$6p4$1@eclipse.org...
> > > If I have two plugins and do the following, I'll end up with:
> > >
> > > Test wrapper
> > > Intefaces
> > > File List
> > > foo.h
> > > foo.idl
> > > ...
> > > Intefaces
> > > File List
> > > bar.h
> > > bar.idl
> > > ...
> > >
> > > Instead, I want to have the following:
> > >
> > > Test wrapper
> > > The foo component api documentation
> > > Intefaces
> > > File List
> > > foo.h
> > > foo.idl
> > > ...
> > > The bar component api documentation
> > > Intefaces
> > > File List
> > > bar.h
> > > bar.idl
> > > ...
> > >
> > > I would prefer NOT to put a extra topic element in the tocs like so:
<toc
> > > label="The foo component api documentation"
> > > link_to="/testwrapper/toc.xml#anchor_id"><topic label="The foo
component
> > > api documentation"><topic href="index.html" label="Interfaces"/>...
> > > because I may also want to use this plugins in contexts where I make
the
> > > toc top down, and it would create an unneeded toc level.
> > >
> > > Is that possible?
> > > Thanks,
> > > David
> > >
> > > toc.xml for wrapper:
> > > ======================================
> > > <?xml version="1.0" encoding="utf-8"?>
> > > <toc label="Test wrapper">
> > > <anchor id="anchor_id"/>
> > > </toc>
> > >
> > > toc.xml for item in wrapper:
> > > ======================================
> > > <toc label="The foo component api documentation"
> > > link_to="/testwrapper/toc.xml#anchor_id">
> > > <topic href="index.html" label="Interfaces"/>
> > > <topic href="files.html" label="File List">
> > > <topic href="foo.h.html" label="foo.h"/>
> > > <topic href="foo.idl.html" label="foo.idl"/>
> > > </topic>
> > > <!-- lots of other topics here -->
> > > </toc>
> > >
> > > toc.xml for another item in wrapper:
> > > ======================================
> > > <toc label="The bar component api documentation"
> > > link_to="/testwrapper/toc.xml#anchor_id">
> > > <topic href="index.html" label="Interfaces"/>
> > > <topic href="files.html" label="File List">
> > > <topic href="bar.h.html" label="bar.h"/>
> > > <topic href="foo.idl.html" label="foo.idl"/>
> > > </topic>
> > > <!-- lots of other topics here -->
> > > </toc>
> > >
>
>
|
|
|
| Re: <toc label=".."> with <anchor> and <link_to> [message #148794 is a reply to message #147431] |
Thu, 23 October 2003 21:46 |
| Eclipse User |
|
|
|
Originally posted by: dcramer.motive.com
Perfect.
In footocglue.xml, you meant <link toc="footoc.xml" />, of course.
^^^ ^^^^^^
Works beautifully.
Thanks!!
David
Konrad Kolosowski wrote:
> toc.xml for wrapper (primary), in a product:
> ======================================
> <?xml version="1.0" encoding="utf-8"?>
> <toc label="Big Book of Components">
> <topic label="High level overview of components" href="overviewpt1.html>
> <!-- Lots of topics in here -->
> <!-- providing high level overview of the system -->
> </topic>
> <topic label="Component Documentation">
> <anchor id="anchor_id"/>
> </topic>
> </toc>
> footoc.xml for wrapper (primary), in a product that has toc.xml, but will
> work separately as well:
> ======================================
> <?xml version="1.0" encoding="utf-8"?>
> <toc label="Foo Component Documentation">
> <!-- Lots of topics in here -->
> </toc>
> footocglue.xml for wrapper (NOT primary), shipped always together with
> footoc.xml, will not do anything if toc.xml not present:
> ======================================
> <?xml version="1.0" encoding="utf-8"?>
> <toc label="Foo Component Documentation Glue"
> link_to="/wrapper/toc.xml#anchor_id" >
> <topic label="Foo Component API Documentation">
> <link href="tocfoo.xml" />
> </topic>
> </toc>
> Will not footocglue.xml do what you need? It ads a topic level only when
> you need it.
> Konrad Kolosowski
> "David Cramer" <dcramer@motive.com> wrote in message
> news:bmpjh0$mof$1@eclipse.org...
> > In this case, I want to have a single <anchor> that receives many plugins.
> > The
> >
> > toc.xml for wrapper:
> > ======================================
> > <?xml version="1.0" encoding="utf-8"?>
> > <toc label="Big Book of Components">
> > <topic label="High level overview of components" href="overviewpt1.html>
> > <!-- Lots of topics in here -->
> > <!-- providing high level overview of the system -->
> > </topic>
> > <topic label="Component Documentation">
> > <anchor id="anchor_id"/>
> > <!-- A large (indeterminant) number of components' api docs point to
> > this single anchor point. I wanted to avoid repeating the label for each
> > one here because the label is already definined in each plugin's toc,
> > which is generated by a api doc generating tool at build time. -->
> > </topic>
> > </toc>
> >
> > I get the impression that it is atypical or outside the bounds of the way
> > the toc was designed. I think it's good that you can define the label that
> > an included toc receives (as the current system allows), but if you are
> > content to use the label on the <toc> element in that toc, it would be
> > nice to be able to do so. Does what I'm trying to do make sense? I realize
> > that I'm having trouble articulating it.
> >
> > Thanks,
> > David
> >
> >
|
|
|
Goto Forum:
Current Time: Thu Aug 29 15:14:36 GMT 2024
Powered by FUDForum. Page generated in 0.04437 seconds |
] 
Search
Help
Register
Login
Home
