Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Tigerstripe » Improvment to publish tool
Improvment to publish tool [message #8345] Wed, 23 April 2008 08:21 Go to next message
Marc FLAUW is currently offline Marc FLAUWFriend
Messages: 100
Registered: July 2009
Senior Member
Hello,

We have a need to be able to document the Tigerstripe model.
I know this can be done by a specific plug-in, but this is a generic need
and I had a look at the result of the publish project and I compared it
with the javadoc html output.

Today, the publish information is not very user-friendly and navigation is
not very easy.


Here are a few remarks:
1) title page: this is too hardcoded. It should be possible to customize
it more to add an overview, a copyright notice...

2) on the title page, there is an empty integration profiles sub-page.
This is correct as I didn't define any integration profile, but this
sub-page should not be present if no profile. On the same topic, the link
"Integration profiles" has 3 pre-defined profiles that points to
pre-defined pages saying information not available.

3) It would be nice to see on the left side all the TS artefacts as it is
presented in the explorer. Today, the left side mix the artefacts and the
navigation.

4) when a category of artefact is selected, it should not remove the
details of the other categories previously expanded.

5) It would be nice to be able to publish both for web and as pdf
document.

Best regards,

Marc
Re: Improvment to publish tool [message #8377 is a reply to message #8345] Wed, 23 April 2008 14:57 Go to previous messageGo to next message
Eric Dillon is currently offline Eric DillonFriend
Messages: 103
Registered: July 2009
Senior Member
Hi Marc,

The "publish" tool of Tigerstripe is one of the very first features we
introduced... A long time back. It requires a lot of attention, mainly as
you mentioned below because it is very hard coded. In fact, it was hard
coded to one of the first versions of the meta-model.

Because of these limitations, we have currently disabled it in the 0.3M0
build posted on the download page.

Your request is very timely, we are having a f2f in Seattle to address these
types of enhancements/requests. I'll put that on the agenda and we'll get
back to you.

We are trying to keep minutes of the meeting up-to-date as we address
various topics. http://wiki.eclipse.org/TigerstripeF2F_20080421

Eric


On 4/23/08 1:21 AM, in article
9e6cf24b5cae7bb662a53bfe209379d6$1@www.eclipse.org, "Marc Flauw"
<marc.flauw@hp.com> wrote:

> Hello,
>
> We have a need to be able to document the Tigerstripe model.
> I know this can be done by a specific plug-in, but this is a generic need
> and I had a look at the result of the publish project and I compared it
> with the javadoc html output.
>
> Today, the publish information is not very user-friendly and navigation is
> not very easy.
>
>
> Here are a few remarks:
> 1) title page: this is too hardcoded. It should be possible to customize
> it more to add an overview, a copyright notice...
>
> 2) on the title page, there is an empty integration profiles sub-page.
> This is correct as I didn't define any integration profile, but this
> sub-page should not be present if no profile. On the same topic, the link
> "Integration profiles" has 3 pre-defined profiles that points to
> pre-defined pages saying information not available.
>
> 3) It would be nice to see on the left side all the TS artefacts as it is
> presented in the explorer. Today, the left side mix the artefacts and the
> navigation.
>
> 4) when a category of artefact is selected, it should not remove the
> details of the other categories previously expanded.
>
> 5) It would be nice to be able to publish both for web and as pdf
> document.
>
> Best regards,
>
> Marc
>
>
Re: Improvment to publish tool [message #8408 is a reply to message #8377] Wed, 23 April 2008 15:26 Go to previous message
Marc FLAUW is currently offline Marc FLAUWFriend
Messages: 100
Registered: July 2009
Senior Member
Eric,

Thanks for the reply.
We have a need in TIP to document the design (IA) phase of the project.
Before, as I understand, it was a Rose model and some word documents.

If we are migrating to the use of TS for doing the IA model, we will have
to understand whether we should use a publish tool or develop our own,
using a plug-in. Of course, there is always the option of developing one,
but the TIP Framework team is likely be quite busy and it is a generic
need to be able to publish the TS model in a nice way.

Best regards,

Marc
Re: Improvment to publish tool [message #562718 is a reply to message #8345] Wed, 23 April 2008 14:57 Go to previous message
Eric Dillon is currently offline Eric DillonFriend
Messages: 103
Registered: July 2009
Senior Member
Hi Marc,

The "publish" tool of Tigerstripe is one of the very first features we
introduced... A long time back. It requires a lot of attention, mainly as
you mentioned below because it is very hard coded. In fact, it was hard
coded to one of the first versions of the meta-model.

Because of these limitations, we have currently disabled it in the 0.3M0
build posted on the download page.

Your request is very timely, we are having a f2f in Seattle to address these
types of enhancements/requests. I'll put that on the agenda and we'll get
back to you.

We are trying to keep minutes of the meeting up-to-date as we address
various topics. http://wiki.eclipse.org/TigerstripeF2F_20080421

Eric


On 4/23/08 1:21 AM, in article
9e6cf24b5cae7bb662a53bfe209379d6$1@www.eclipse.org, "Marc Flauw"
<marc.flauw@hp.com> wrote:

> Hello,
>
> We have a need to be able to document the Tigerstripe model.
> I know this can be done by a specific plug-in, but this is a generic need
> and I had a look at the result of the publish project and I compared it
> with the javadoc html output.
>
> Today, the publish information is not very user-friendly and navigation is
> not very easy.
>
>
> Here are a few remarks:
> 1) title page: this is too hardcoded. It should be possible to customize
> it more to add an overview, a copyright notice...
>
> 2) on the title page, there is an empty integration profiles sub-page.
> This is correct as I didn't define any integration profile, but this
> sub-page should not be present if no profile. On the same topic, the link
> "Integration profiles" has 3 pre-defined profiles that points to
> pre-defined pages saying information not available.
>
> 3) It would be nice to see on the left side all the TS artefacts as it is
> presented in the explorer. Today, the left side mix the artefacts and the
> navigation.
>
> 4) when a category of artefact is selected, it should not remove the
> details of the other categories previously expanded.
>
> 5) It would be nice to be able to publish both for web and as pdf
> document.
>
> Best regards,
>
> Marc
>
>
Re: Improvment to publish tool [message #562742 is a reply to message #8377] Wed, 23 April 2008 15:26 Go to previous message
Marc FLAUW is currently offline Marc FLAUWFriend
Messages: 100
Registered: July 2009
Senior Member
Eric,

Thanks for the reply.
We have a need in TIP to document the design (IA) phase of the project.
Before, as I understand, it was a Rose model and some word documents.

If we are migrating to the use of TS for doing the IA model, we will have
to understand whether we should use a publish tool or develop our own,
using a plug-in. Of course, there is always the option of developing one,
but the TIP Framework team is likely be quite busy and it is a generic
need to be able to publish the TS model in a nice way.

Best regards,

Marc
Previous Topic:Improvment to publish tool
Next Topic:How do exceptions work?
Goto Forum:
  


Current Time: Mon Dec 22 04:19:51 GMT 2014

Powered by FUDForum. Page generated in 0.01778 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software