Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [birt-dev] Wiki Examples Section

Hi Jason,
 
I modified this page:
 
http://wiki.eclipse.org/index.php/Report_Developer_Examples_%28BIRT%29
 
With the structure outlined in this thread.  I did not change the title of the page from
Report Developer Examples (BIRT) yet, since I wasn't sure what you wanted this page to be called.
 
I see how you added a link to the top of the page that goes to this page though:
 
http://wiki.eclipse.org/index.php/Examples_%28BIRT%29
 
That page looks nice.  Based on our discussions, I'm guessing the Community Examples section will be reworked though to point to just the page I edited above.. instead of 3 separate links to the Report Developer Examples, Integration Examples, and Extension Examples?  Or were you thinking of having them link to the appropriate section in the page I just modified?
 
Let me know if you need additional help.
 
Thanks,
 
Susan

----- Original Message ----
From: Jason Weathersby <jasonweathersby@xxxxxxxxxx>
To: birt-dev@xxxxxxxxxxx
Sent: Tuesday, February 20, 2007 10:00:17 AM
Subject: [birt-dev] Wiki Examples Section

Susan,

I agree with your observation.  I will try to make changes to the template
to specify more information in bugzilla.  It is definately ok to add
categories to the
page as well.  If you want to take a stab at altering the example layout
that would be great.  No need to put content under it yet, but put the
initial layout in.
I will then move the content we have out there under the proper category.

What do you think?

Jason

----- Original Message -----
From: <birt-dev-request@xxxxxxxxxxx>
To: <birt-dev@xxxxxxxxxxx>
Sent: Monday, February 19, 2007 11:39 AM
Subject: birt-dev Digest, Vol 23, Issue 73


> Send birt-dev mailing list submissions to
> birt-dev@xxxxxxxxxxx
>
> To subscribe or unsubscribe via the World Wide Web, visit
> https://dev.eclipse.org/mailman/listinfo/birt-dev
> or, via email, send a message with subject or body 'help' to
> birt-dev-request@xxxxxxxxxxx
>
> You can reach the person managing the list at
> birt-dev-owner@xxxxxxxxxxx
>
> When replying, please edit your Subject line so it is more specific
> than "Re: Contents of birt-dev digest..."
>
>
> Today's Topics:
>
>   1. Re: Re: birt-dev Digest, Vol 23, Issue 50 (home4slc@xxxxxxxxxxx)
>
>
> ----------------------------------------------------------------------
>
> Message: 1
> Date: Mon, 19 Feb 2007 08:39:27 -0800 (PST)
> From: home4slc@xxxxxxxxxxx
> Subject: Re: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
> To: Jason Weathersby <jasonweathersby@xxxxxxxxxx>, Scott Rosenbaum
> <scottr@xxxxxxxxxxxxxxxxxxxxx>, birt-dev@xxxxxxxxxxx
> Message-ID: <689602.32584.qm@xxxxxxxxxxxxxxxxxxxxxxxxxxx>
> Content-Type: text/plain; charset="iso-8859-1"
>
> Hi Jason,
>
> Good.  Glad that this makes sense to you.  Let me know how I can help edit
> / add pages.
>
> Regarding the page you set up with instructions to add content to here:
>
> http://wiki.eclipse.org/index.php/Contributing_Examples_%28BIRT%29
>
> Just a couple of comments.  Under the 'New Wiki Page' section template.  I
> like the template - but if folks want to add a category or two is this
> okay?  If so, maybe we can say to use the template, but you can add a
> category if for your specific topic you need to add a category?  If you
> think this isn't okay - then just leave it.
>
> In the Example Files section, this sentence:
>
> In the bugzilla entry you create specify "Example -" name of your wiki
> page for the summary field. For example, the summary field may contain
> "Example - Stored Procedure (BIRT)". In the Severity field, tag the bug as
> an Enhancement.
>
> Should the person making the entry also select a Version in bugzilla?  For
> instance if the example only applies to a 2.2 feature, should they select
> this as a version?  What about the component, documentation?
>
> Thanks for adding this page, Jason.
>
> Regards,
>
> Susan
>
> ----- Original Message ----
> From: Jason Weathersby <jasonweathersby@xxxxxxxxxx>
> To: home4slc@xxxxxxxxxxx; Scott Rosenbaum <scottr@xxxxxxxxxxxxxxxxxxxxx>;
> birt-dev@xxxxxxxxxxx
> Sent: Friday, February 16, 2007 10:55:14 AM
> Subject: Re: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
>
>
> Susan,
>
> This is good.  My plan was to add the other areas, but I wanted to get the
> Report Developer section up firt.  I planned on wrapping the birt2.1
> examples into this structure.
> I like the structure you present.  I vote that we move forward on this
> structure and refactor existing examples to this location.  I also want
> the process for adding content to be finalized.
>
> Jason
>
> ----- Original Message -----
> From: home4slc@xxxxxxxxxxx
> To: Scott Rosenbaum ; Jason Weathersby ; birt-dev@xxxxxxxxxxx
> Sent: Friday, February 16, 2007 1:10 PM
> Subject: Re: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
>
>
> Hi,
>
> Thanks for commenting on this post so we could discuss it further.  When I
> posted my suggestion I did so because I thought that Jason's idea was to
> restrict this area to Report Developer examples, since this is the name of
> the page.
>
> I'm confused what the plan for the overall structure is.  With Scott's
> proposal it has categories for Report Developers, Integration and
> Extensions on one page.  I think this is fine if this is a top level page,
> however it is not in sync with the
> 'FAQ/Wiki' link from the BIRT website
> (http://wiki.eclipse.org/index.php/BIRT_Project ), which if you click the
> BIRT2.1: BIRT 2.1 Examples (http://wiki.eclipse.org/index.php/BIRT2.1/)
> link shows these categories:
>
> BIRT Report Feature Examples - goes to website
> BIRT Report Designer  - no link
> BIRT Report Engine API - goes to wiki
> BIRT Chart Engine API - no link
> BIRT Design Engine API - goes to wiki
> BIRT Viewer - no link
>
> These are a little bit a mix of Report Developer, Integration and
> Deployment (?).
> Is the proposed new structure to put the new page under discussion off
> this page - if so, what would be it's name/category?
>
> Here's a proposal, just to throw something out that folks could comment
> on:
>
> What about making this page:
> http://wiki.eclipse.org/index.php/BIRT2.1/
>
> Be the new wiki home to all examples.  The existing Report and Design
> engine API examples could be folded into the new structure, and maybe we
> add a sample reports / Demo section to cover the 'BIRT Report Feature
> Examples' section that currently links back to the website?
>
> Essentially it could be the page that Scott was proposing below with an
> addition or two.
> So instead of having just the 6 categories now it would be something like
> this (the BIRT Viewer is not on this list - is this covered by the
> Integration > Report Engine API > Web Deployment or should it be added?):
>
> Report Development
>            Example Reports and Demo - links to 'BIRT Report Feature
> Examples' from index.php/BIRT2.1
>            Data Source
>            Accessing and Binding Data
>                        Scripted Data Source
>                        XML Data Source
>                        StoredProcedure
>                        JNDI Data Source
>            Retrieving Data
>                        Specifying Data to retrieve from an XML data source
>            Sorting and Grouping Data
>                        Grouping
>                        Nested Groups
>                        Aggregrating Data
>
>            Report Elements
>                       Nested Tables
> Dynamic Image
>
>            Writing Expressions
>                        BIRT Functions
> Native _javascript_ Functions
>
>            Filtering Data
>                        Best Practices (?) about where to do it...
>
>            Scripting
>                        _javascript_ Event Handlers
>                        Java Event Handlers
>
>            Shared Report Development
>                        Templates
>                         Libraries
>
>            Charts
>                        Displaying Data in Charts - Series Definitions (?)
>                        Adding a Chart to a Report Design(?)
>
> Integration
>            Design Time API
>                        report design topics
>                        chart design topics
>            Report Engine API
>                        Web Integration
>                        RCP Integration
>                        Stand-Alone Integration
>                        Non-java integration
>
>              Chart Engine API
>                        Simple Chart API examples (extract a few from the
> source?)
>
> Extension
>            Data Extension
>                        ODA Runtime
>                        ODA Design Time
>                        Driver Bridge
>
>            ReportItem Extension
>            Chart Extension
>            Emitter Extension
>
> Once we have agreement about the structure, I'd be happy to work with
> Jason and help edit / create new pages so he doesn't have to do all the
> work.
>
> Thanks,
>
> Susan
> ----- Original Message ----
> From: Scott Rosenbaum <scottr@xxxxxxxxxxxxxxxxxxxxx>
> To: Susan Cline <home4slc@xxxxxxxxxxx>; Jason Weathersby
> <jasonweathersby@xxxxxxxxxx>; birt-dev@xxxxxxxxxxx
> Sent: Thursday, February 15, 2007 5:41:58 PM
> Subject: RE: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
>
>
> Susan and Jason,
>
> Sorry, I had a conversation on the phone with Jason.  (note to self,
> phones are not very open)
>
> In any case, I think that the basic outline looks pretty good.   As I read
> your list, it looks like your examples categories are primarily based on
> report development.  I think that we need to have additional categories
> for Integration and Extension.  So you would end up with categories that
> look like:
>
> Report Development
>            (same list as below)
>
> Integration
>            Design Time API
>                        report design topics
>                        chart design topics
>            Report Engine API
>                        Web Integration
>                        RCP Integration
>                        Stand-Alone Integration
>                        Non-java integration
> Extension
>            Data Extension
>                        ODA Runtime
>                        ODA Design Time
>                        Driver Bridge
>            ReportItem Extension
>
>            Chart Extension
>
>            Emitter Extension
>
> If I had one over all goal it would be to provide good top level access to
> the individual items that make up the wiki.  I would rather have fewer,
> bigger index pages with lots of categories in each page.  I feel that this
> allows people to get a better feel for what the categories mean.  I am a
> particular fan of the way the PHP docs are setup
> (http://www.php.net/manual/en/index.php).
>
> I wonder if it is better to split the examples into their own location or
> to mix them in amongst the other content?  Truthfully, Jason has done most
> of the work and it looks like that will continue, so I will pretty much
> defer to what ever he wants to do.
>
> Scott Rosenbaum
>
>
>
>
>
> From: birt-dev-bounces@xxxxxxxxxxx [mailto:birt-dev-bounces@xxxxxxxxxxx]
> On Behalf Of Susan Cline
> Sent: Thursday, February 15, 2007 2:48 PM
> To: Jason Weathersby; birt-dev@xxxxxxxxxxx
> Subject: Re: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
>
> Hi Jason,
>
> Okay, I'll lay off the website structure for now ;-)
>
> Unfortunately it seems no one else has piped in with a suggestion for the
> wiki example organization with additional content suggestions or
> structure.  I was hoping to get more feedback from other folks in the
> community as well on this.
>
> Here are my thoughts based loosely on the structure the two BIRT books use
> (hopefully you can see my indents?):
>
>
> Data Source
>            Accessing and Binding Data
>                        Scripted Data Source
>                        XML Data Source
>                        StoredProcedure
>                        JNDI Data Source
>
>            Retrieving Data
>                        Specifying Data to retrieve from an XML data source
> Sorting and Grouping Data
>            Grouping
>            Nested Groups
>            Aggregrating Data
> Report Elements
>            Nested Tables
>            Dynamic Image
> Writing Expressions
>            BIRT Functions
>            Native _javascript_ Functions
> Filtering Data
>            Best Practices (?) about where to do it...
> Scripting
>            _javascript_ Event Handlers
>            Java Event Handlers
> Shared Report Development
>            Templates
>            Libraries
> Charts
>            Displaying Data in Charts - Series Definitions (?)
>            Adding a Chart to a Report Design(?)
>
> It seems to make sense to make some higher level categories, so when
> people want to add new examples they will understand where to put them.
>
> Regards,
>
> Susan
> ----- Original Message ----
> From: Jason Weathersby <jasonweathersby@xxxxxxxxxx>
> To: birt-dev@xxxxxxxxxxx
> Sent: Monday, February 12, 2007 7:43:00 AM
> Subject: [birt-dev] Re: birt-dev Digest, Vol 23, Issue 50
> Susan,
>
> Thanks for your imput.  The idea is to move the API wiki examples
> (http://wiki.eclipse.org/index.php/BIRT2.1/) under the new structure, but
> the http://www.eclipse.org/birt/phoenix/deploy/ page would stay as this
> gives general descriptions of the APIs.  This page will be reworked
> to be less confusing though.  The only examples that would remain on the
> web
> site proper are the flash videos, solution reports, and the tutorial.
> I like the idea of further dividing the wiki examples structure.  It would
> be nice to get feedback on what the community would like to see.  Ie what
> categories am I missing.  I also believe changing the names on the toc to
> be
> more logical is definately needed.
>
> As far as changing the left nav bars etc, I would prefer to hold on this
> conversation until we can get a good example structure up that is not
> confusing.
>
> Jason
>
>
> ----- Original Message -----
> From: <birt-dev-request@xxxxxxxxxxx>
> To: <birt-dev@xxxxxxxxxxx>
> Sent: Saturday, February 10, 2007 12:00 PM
> Subject: birt-dev Digest, Vol 23, Issue 50
>
>
>> Send birt-dev mailing list submissions to
>> birt-dev@xxxxxxxxxxx
>>
>> To subscribe or unsubscribe via the World Wide Web, visit
>> https://dev.eclipse.org/mailman/listinfo/birt-dev
>> or, via email, send a message with subject or body 'help' to
>> birt-dev-request@xxxxxxxxxxx
>>
>> You can reach the person managing the list at
>> birt-dev-owner@xxxxxxxxxxx
>>
>> When replying, please edit your Subject line so it is more specific
>> than "Re: Contents of birt-dev digest..."
>>
>>
>> Today's Topics:
>>
>>   1. Re: Wiki Examples (home4slc@xxxxxxxxxxx)
>>
>>
>> ----------------------------------------------------------------------
>>
>> Message: 1
>> Date: Fri, 9 Feb 2007 14:15:51 -0800 (PST)
>> From: home4slc@xxxxxxxxxxx
>> Subject: Re: [birt-dev] Wiki Examples
>> To: Jason Weathersby <jasonweathersby@xxxxxxxxxx>,
>> birt-dev@xxxxxxxxxxx
>> Message-ID: <143886.6727.qm@xxxxxxxxxxxxxxxxxxxxxxxxxxx>
>> Content-Type: text/plain; charset="iso-8859-1"
>>
>> Hi Jason,
>>
>> Thanks for providing some more structure for the examples.
>>
>> I agree that the Stored Procedure page could be split - are you thinking
>> about having one page that is a generic Stored Procedure page with links
>> to specific examples of Stored Procedures for different databases?  This
>> seems good to me.
>>
>> Also, I agree that this page:
>> http://wiki.eclipse.org/index.php/Report_Developer_Examples_%28BIRT%29
>> needs some more organization.  Maybe make each major category have it's
>> own link (with a brief description of the contents of each category) and
>> then have a new page for each category?
>>
>> I've noticed that the new page encompasses 2 of the top level links on
>> the
>> website.
>>
>> Name on wiki page        Name on WebSite link                URL
>> BIRT Tutorial                Tutorial
>> http://www.eclipse.org/birt/phoenix/tutorial/
>> BIRT Flash Videos        Examples
>> http://www.eclipse.org/birt/phoenix/examples/
>> (Also, the top level FAQ/Wiki >  FAQ > Examples points to this page.
>>
>> Will it eventually point to these examples as well?
>>
>> http://www.eclipse.org/birt/phoenix/deploy/
>>
>> which is navigated to from the BIRT home page > Integration left frame
>> link?
>>
>> If the new page will point to the
>> http://www.eclipse.org/birt/phoenix/deploy/ link, there might not be
>> enough room on the new page, and instead it maybe should just contain
>> links to the major categories of example types.
>>
>> Also, I think the name 'BIRT Flash Videos' in the new page is a bit
>> misleading because a) some of the other references mentioned above just
>> call them 'Examples' and b) they contain a lot more information then just
>> Flash Videos.  I'm worried people might not browse that link because of
>> the name.  Maybe change the name to 'BIRT Flash Videos and Solution
>> Reports'?
>>
>> An overall question that may help me understand the current organization
>> and give input into the structure going forward is the differentiation
>> between content placed on the website and content which goes on the wiki.
>> I realize that content on the wiki can be edited by anyone with a
>> bugzilla
>> id, but I'm thinking more in terms of overall content organization.
>>
>> Currently I find the organization of examples (regardless of where they
>> come from) somewhat confusing, because they seem to reside in several
>> different places and I don't understand how they are differentiated.
>>
>> Where will the new page be referenced from?
>>
>> On a slightly different topic, I give some input earlier about the
>> organization of the web site, and think it is appropriate to discuss it
>> here again.
>>
>> Some of the current categories on the left nav are confusing to me. I'd
>> like to suggest that there be some broader categories and then some sub
>> categories.  For instance, the broad categories would be based more on
>> the
>> type of user that visits the website (user / report developer,
>> contributor
>> and committer information), versus the content categories we have now. I
>> think this fits in with the redesign of the wiki examples.
>>
>> Is this something the community is amenable to receiving input on?
>>
>> Thanks again for doing this Jason, I realize organizing this is time
>> consuming and non-trivial.
>>
>> Regards,
>>
>> Susan
>> ----- Original Message ----
>> From: Jason Weathersby <jasonweathersby@xxxxxxxxxx>
>> To: birt-dev@xxxxxxxxxxx
>> Sent: Friday, February 9, 2007 10:05:58 AM
>> Subject: [birt-dev] Wiki Examples
>>
>>
>> I would like to get feedback on the community examples section located
>> here:
>> http://wiki.eclipse.org/index.php/Examples_%28BIRT%29
>>
>> Currently there is only one example in the structure which is the stored
>> procedure example.
>> After looking at that example I think it should be split, one for MySQL
>> and another for Derby .
>> The TOC for Report Examples needs more as well.
>>
>> Jason
>>
>> _______________________________________________
>> birt-dev mailing list
>> birt-dev@xxxxxxxxxxx
>> https://dev.eclipse.org/mailman/listinfo/birt-dev
>> -------------- next part --------------
>> An HTML attachment was scrubbed...
>> URL:
>> https://dev.eclipse.org/mailman/listinfo/birt-dev/attachments/20070209/84b887f9/attachment.html
>>
>> ------------------------------
>>
>> _______________________________________________
>> birt-dev mailing list
>> birt-dev@xxxxxxxxxxx
>> https://dev.eclipse.org/mailman/listinfo/birt-dev
>>
>>
>> End of birt-dev Digest, Vol 23, Issue 50
>> ****************************************
>
> _______________________________________________
> birt-dev mailing list
> birt-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/birt-dev
> -------------- next part --------------
> An HTML attachment was scrubbed...
> URL:
> https://dev.eclipse.org/mailman/listinfo/birt-dev/attachments/20070219/bec199ba/attachment.html
>
> ------------------------------
>
> _______________________________________________
> birt-dev mailing list
> birt-dev@xxxxxxxxxxx
> https://dev.eclipse.org/mailman/listinfo/birt-dev
>
>
> End of birt-dev Digest, Vol 23, Issue 73
> ****************************************

_______________________________________________
birt-dev mailing list
birt-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/birt-dev


Back to the top