You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cayenne.apache.org by Cris Daniluk <cr...@gmail.com> on 2006/04/17 16:51:10 UTC

docs sample

Resending this for the nth time after having the attachment rejected as
spam...

With b2 impending, I thought I'd share the current state of the docs. I've
retooled a lot... the attempt to use integrate with the anakia templates wa=
s
a waste of time. The way it handles the TOC generation is a bit limiting.
So, I've just combined a simple velocity template with a whole bunch of
regexp loving to get to where we're at now. I'm sure a more elegant solutio=
n
exists, but being as we have to get this thing done, and being as any Apach=
e
mandates might change how we do this, I didn't want to go crazy :)

There were a lot of interesting issues, as we basically had to post-process
the Confluence-rendered HTML to rewrite different types of links. The
attached docs still have an issue with cross-linking to other documents (it
can link to child docs but not across the tree). There is also a cute
rendering bug in IE on the toc (border shows inside the bullets). All quick
fixes, but I wanted to get what's done out there for comment.

I also put a little hack in to specify page ordering - within an {excerpt}
on a page, you can specify the sort order you would like for children. I've
already included this on the User Guide page. Confluence doesn't honor it o=
f
course, but the static export does.

Also, I scrapped the existing doc template in favor of something more
consistent with the Confluence documentation format. It is all velocity/css
styled though, so we can easily move back if anyone objects. Let me know
what you guys think.

Cris

Re: docs sample

Posted by Andrus Adamchik <an...@objectstyle.org>.
On Apr 17, 2006, at 7:21 PM, Andrus Adamchik wrote:

> use the web space provided by Apache on people.apache.org (I  
> haven't yet tried the last one, so I don't know what needs to be  
> done to serve stuff from a home dir... should be something simple).

It is simple - just create a folder "public_html" in your HOME dir on  
the people.apache.org server. I just typed something in vi in mine :-)

http://people.apache.org/~aadamchik/

Andrus


Re: docs sample

Posted by Andrus Adamchik <an...@objectstyle.org>.
There are a few ways around it - create a dummy confluence page and  
upload attachments there or use the web space provided by Apache on  
people.apache.org (I haven't yet tried the last one, so I don't know  
what needs to be done to serve stuff from a home dir... should be  
something simple).

Andrus

On Apr 17, 2006, at 7:17 PM, Cris Daniluk wrote:

> Yeah... It was flagging it as spam. Though, when I sent the attachment
> directly to committers, it even bounced to Bill's apache account,  
> so who
> knows?
>
> I'll try the rename next time around.
>
> Cris
>
> On 4/17/06, Mike Kienenberger <mk...@gmail.com> wrote:
>>
>> On 4/17/06, Cris Daniluk <cr...@gmail.com> wrote:
>>> Resending this for the nth time after having the attachment  
>>> rejected as
>>> spam...
>>
>> Cris,  are you having troubles sending zip file attachments?
>> If so, I think we need to ask INFRA to change our mailing list  
>> settings.
>>
>> As a temporary workaround, I'm told that you can rename the file to
>> *.txt (ie, file.zip.txt) so that it will transmit.
>>


Re: docs sample

Posted by Cris Daniluk <cr...@gmail.com>.
Yeah... It was flagging it as spam. Though, when I sent the attachment
directly to committers, it even bounced to Bill's apache account, so who
knows?

I'll try the rename next time around.

Cris

On 4/17/06, Mike Kienenberger <mk...@gmail.com> wrote:
>
> On 4/17/06, Cris Daniluk <cr...@gmail.com> wrote:
> > Resending this for the nth time after having the attachment rejected as
> > spam...
>
> Cris,  are you having troubles sending zip file attachments?
> If so, I think we need to ask INFRA to change our mailing list settings.
>
> As a temporary workaround, I'm told that you can rename the file to
> *.txt (ie, file.zip.txt) so that it will transmit.
>

Re: docs sample

Posted by Mike Kienenberger <mk...@gmail.com>.
On 4/17/06, Cris Daniluk <cr...@gmail.com> wrote:
> Resending this for the nth time after having the attachment rejected as
> spam...

Cris,  are you having troubles sending zip file attachments?
If so, I think we need to ask INFRA to change our mailing list settings.

As a temporary workaround, I'm told that you can rename the file to
*.txt (ie, file.zip.txt) so that it will transmit.

Re: docs sample

Posted by Cris Daniluk <cr...@gmail.com>.
Okay - I will incorporate some of the feedback from others, fix some of the
bugs, and see how it looks.

FYI, this all uses the Confluence SOAP API and is driven by an ant task. It
works great, but fails about 5% of the time I run it. There's about 200 SOAP
requests, and one failure shuts it all down. Maybe we could toss in some
handling for that, because it would be kind of annoying to have to re-run
the whole release task again.

Cris

On 4/17/06, Andrus Adamchik <an...@objectstyle.org> wrote:
>
> Very nice, I like it. Let's not worry about matching the looks with
> the stuff currently produced by Anakia. Confluence theme is nice and
> clean.
>
> Andrus
>
>
> On Apr 17, 2006, at 6:51 PM, Cris Daniluk wrote:
>
> > Resending this for the nth time after having the attachment
> > rejected as
> > spam...
> >
> > With b2 impending, I thought I'd share the current state of the
> > docs. I've
> > retooled a lot... the attempt to use integrate with the anakia
> > templates wa=
> > s
> > a waste of time. The way it handles the TOC generation is a bit
> > limiting.
> > So, I've just combined a simple velocity template with a whole
> > bunch of
> > regexp loving to get to where we're at now. I'm sure a more elegant
> > solutio=
> > n
> > exists, but being as we have to get this thing done, and being as
> > any Apach=
> > e
> > mandates might change how we do this, I didn't want to go crazy :)
> >
> > There were a lot of interesting issues, as we basically had to post-
> > process
> > the Confluence-rendered HTML to rewrite different types of links. The
> > attached docs still have an issue with cross-linking to other
> > documents (it
> > can link to child docs but not across the tree). There is also a cute
> > rendering bug in IE on the toc (border shows inside the bullets).
> > All quick
> > fixes, but I wanted to get what's done out there for comment.
> >
> > I also put a little hack in to specify page ordering - within an
> > {excerpt}
> > on a page, you can specify the sort order you would like for
> > children. I've
> > already included this on the User Guide page. Confluence doesn't
> > honor it o=
> > f
> > course, but the static export does.
> >
> > Also, I scrapped the existing doc template in favor of something more
> > consistent with the Confluence documentation format. It is all
> > velocity/css
> > styled though, so we can easily move back if anyone objects. Let me
> > know
> > what you guys think.
> >
> > Cris
>
>

Re: docs sample

Posted by Andrus Adamchik <an...@objectstyle.org>.
Very nice, I like it. Let's not worry about matching the looks with  
the stuff currently produced by Anakia. Confluence theme is nice and  
clean.

Andrus


On Apr 17, 2006, at 6:51 PM, Cris Daniluk wrote:

> Resending this for the nth time after having the attachment  
> rejected as
> spam...
>
> With b2 impending, I thought I'd share the current state of the  
> docs. I've
> retooled a lot... the attempt to use integrate with the anakia  
> templates wa=
> s
> a waste of time. The way it handles the TOC generation is a bit  
> limiting.
> So, I've just combined a simple velocity template with a whole  
> bunch of
> regexp loving to get to where we're at now. I'm sure a more elegant  
> solutio=
> n
> exists, but being as we have to get this thing done, and being as  
> any Apach=
> e
> mandates might change how we do this, I didn't want to go crazy :)
>
> There were a lot of interesting issues, as we basically had to post- 
> process
> the Confluence-rendered HTML to rewrite different types of links. The
> attached docs still have an issue with cross-linking to other  
> documents (it
> can link to child docs but not across the tree). There is also a cute
> rendering bug in IE on the toc (border shows inside the bullets).  
> All quick
> fixes, but I wanted to get what's done out there for comment.
>
> I also put a little hack in to specify page ordering - within an  
> {excerpt}
> on a page, you can specify the sort order you would like for  
> children. I've
> already included this on the User Guide page. Confluence doesn't  
> honor it o=
> f
> course, but the static export does.
>
> Also, I scrapped the existing doc template in favor of something more
> consistent with the Confluence documentation format. It is all  
> velocity/css
> styled though, so we can easily move back if anyone objects. Let me  
> know
> what you guys think.
>
> Cris