iUI Guide/Manual

33 views
Skip to first unread message

StanRB

unread,
Nov 20, 2009, 11:23:32 PM11/20/09
to iui-developers
So it's time! For an iUI manual. I have a lot of personal time on my
hands that I want to invest in the iUI project. After convincing my
employer to use it as the base framework we will be building our app
on, I decided to get further involved and, if not able to fully help
with code, help with what I'm best at - manuals... I'd like to put
together a iUI Start Up Guide, tutorials, whatever comes to mind. I
have already started and I did a lot of background research and...
there is very little info out there in the form of tutorials...
anyway... Here is my question to YOU (questions):

What do you perceive are the most important things to touch upon? What
areas need to be covered first or more in depth?

How would you suggest to go about all this? Organization-wise...

Does anybody else want in?

Any advice?


Going to bed now.

Cheers!

Stan
A fairly young Instructional Multimedia Specialist at
Adelphi University in NY

Sean Gilligan

unread,
Nov 23, 2009, 10:02:23 AM11/23/09
to iui-dev...@googlegroups.com
StanRB wrote:
> So it's time! For an iUI manual.

That's great news, Stan!

> I have a lot of personal time on my
> hands that I want to invest in the iUI project. After convincing my
> employer to use it as the base framework we will be building our app
> on, I decided to get further involved and, if not able to fully help
> with code, help with what I'm best at - manuals... I'd like to put
> together a iUI Start Up Guide, tutorials, whatever comes to mind.

The four pieces of documentation iUI needs most, in my opinion are:

1) A really good, "official" Getting Started tutorial
2) An conceptual overview that explains how it works and where it fits
in the big picture
3) A comprehensive reference
4) In-code comments and documentation using one of the "JSDoc" systems


> I
> have already started and I did a lot of background research and...
> there is very little info out there in the form of tutorials...
>

The best one that I know if is this one:
http://www.k10design.net/articles/iui/

Joe Hewitt's video is worth watching:
http://video.yahoo.com/watch/853528/3491272

There are also two books that I know of:
1) http://www.manning.com/callen/

2) http://www.wrox.com/WileyCDA/WroxTitle/productCd-0470251557.html
which has recently been updated:
http://www.amazon.com/Safari-WebKit-Development-iPhone-3-0/dp/0470549661/



> anyway... Here is my question to YOU (questions):
>
> What do you perceive are the most important things to touch upon?

See above. The "getting started guide" should address the FAQ from
iPhoneWebDev, etc.

> What
> areas need to be covered first or more in depth?
>

See above.
> How would you suggest to go about all this? Organization-wise...
>

You're the one with the ideas, time, and inclination, so it's really up
to you. I'd love to kibitz, contribute, and criticize -- not
necessarily in that order.

I'm hoping you're going to contribute the documentation to the project,
thus making it "official" documentation available on Google Code or on
an iUI website if we end up making one. Google Code is configured to
state that the "Code license" is "New BSD" and the "content license"
(for the site) is Creative Commons 3.0 BY-SA. I think the CC license
might be the best choice for the manual.

Possible choices for documentation format that I would consider
acceptable include: Google Code Wiki, HTML, DocBook, or OpenOffice. For
Getting Started/Tutorial type things the Wiki could be a good place to
start. For a comprehensive manual, I'd like to see either HTML or
DocBook managed by Mercurial. DocBook has a bit of learning curve, but
it can generate nice reference sites AND pdfs. HTML5 has actually
adopted a few of DocBook's features, but I don't know if there are any
good Open Source PDF generators for HTML5 yet. If you're up for
DocBook, I can give you some pointers on free tools.

There's also the issue about code comments and JSDoc...

-- Sean


Remi Grumeau

unread,
Nov 23, 2009, 8:26:18 AM11/23/09
to iui-dev...@googlegroups.com
Lets start a first summary. it's definitly a first shot so it's
totally open to debate :)

Introduction
- What is a webapp
- What it does and can't do,
- How it works
- Main differences between iUI and other frameworks, to date

Getting started
- What is iUI
- First installation
- Hello World (in a panel view)
- Manage a listing
- Graphical personnalisation (theme)
- iUI and other JS toolkit (Google Maps, jQuery, ...)

iUI API
- Introducing Sandbox
- Javascript classes listing
- CSS classes listing

Examples
- Music sample
- Photo gallery
- Projects that use iUI

Additionnal ressources
- have no idea but all the rest .. ? :)


My 0,02€, feedback (and debate) welcomes !

Remi
> --
>
> You received this message because you are subscribed to the Google Groups "iui-developers" group.
> To post to this group, send email to iui-dev...@googlegroups.com.
> To unsubscribe from this group, send email to iui-developer...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/iui-developers?hl=.
>
>
>

StanRB

unread,
Nov 23, 2009, 11:33:22 AM11/23/09
to iui-developers
WOW! You just made it much more serious ;). I have a lot to think
about now. I will use the Thanksgiving break to decide the tools and
starting putting some words on paper. I will start with a start up
guide and the likes and maybe work on the code comments as I become
more familiar with the code and more into it (through the development
of my school's app). I was not familiar with DocBook until now and
will be checking this as well. If it is not too steep of a learning
curve I'll go that way. Otherwise I think I will start with OpenOffice
and the Wiki pages on google code... Its about time a webpage with a
dedicated name is created for the project. I almost bought the domain
today ;)... Anyway - thanks for the feedback! Great comments! Anybody
else - feel free to respond. I will be updating with my progress here!

Cheers!

Stan

On Nov 23, 10:02 am, Sean Gilligan <msgilli...@gmail.com> wrote:
> StanRB wrote:
> > So it's time! For an iUI manual.
>
> That's great news, Stan!
>
> >  I have a lot of personal time on my
> > hands that I want to invest in the iUI project. After convincing my
> > employer to use it as the base framework we will be building our app
> > on, I decided to get further involved and, if not able to fully help
> > with code, help with what I'm best at - manuals... I'd like to put
> > together a iUI Start Up Guide, tutorials, whatever comes to mind.
>
> The four pieces of documentation iUI needs most, in my opinion are:
>
> 1) A really good, "official" Getting Started tutorial
> 2) An conceptual overview that explains how it works and where it fits
> in the big picture
> 3) A comprehensive reference
> 4) In-code comments and documentation using one of the "JSDoc" systems
>
> >  I
> > have already started and I did a lot of background research and...
> > there is very little info out there in the form of tutorials...
>
> The best one that I know if is this one:http://www.k10design.net/articles/iui/
>
> Joe Hewitt's video is worth watching:http://video.yahoo.com/watch/853528/3491272
>
> There are also two books that I know of:
> 1)http://www.manning.com/callen/
>
> 2)http://www.wrox.com/WileyCDA/WroxTitle/productCd-0470251557.html
> which has recently been updated:http://www.amazon.com/Safari-WebKit-Development-iPhone-3-0/dp/0470549...

Sean Gilligan

unread,
Nov 23, 2009, 12:50:08 PM11/23/09
to iui-dev...@googlegroups.com
StanRB wrote:
> WOW! You just made it much more serious ;).

I don't mean to make it too serious. Hopefully, it can still be fun...

> I have a lot to think
> about now. I will use the Thanksgiving break to decide the tools and
> starting putting some words on paper. I will start with a start up
> guide and the likes and maybe work on the code comments as I become
> more familiar with the code and more into it (through the development
> of my school's app). I was not familiar with DocBook until now and
> will be checking this as well.

I created some pages (using the Website flavor of DocBook -- which I
don't recommend) years ago with some introductory info on DocBook:
http://msgilligan.com/docbook.html

I'd recommend trying XMLmind XML Editor (free, personal edition) to
familiarize yourself with the model.

Examples of successful projects that use DocBook include:

Linux: http://tldp.org/
Spring:
http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/
Hibernate: http://docs.jboss.org/hibernate/stable/core/reference/en/html/

You definitely don't need to know every DocBook tag to use DocBook. The
simplified DocBook vocabulary/doctype would be fine or any reasonable
subset.

HTML5 includes the <section>, <article>, and <figure> tags which makes
HTML5 very DocBook-like. I don't know if there are any good tools (XSL
stylesheets?) for going from HTML5 to PDF yet.


> If it is not too steep of a learning
> curve I'll go that way.

If you can create DocBook documentation, I'll merge/checkin to Mercurial
and integrate a DocBook toolchain into the build process.

> Otherwise I think I will start with OpenOffice
> and the Wiki pages on google code...

The problem with OpenOffice is that it is not well suited to tracking in
revision control. (I could be wrong, but I haven't seen it done
before) The same problem exists, of course, for MS-Word, but at least
OpenOffice is freely available to anyone who wants to contribute.

> Its about time a webpage with a
> dedicated name is created for the project. I almost bought the domain
> today ;)...
I have already purchased some domains:
iuijs.org and iui-js.org

I was thinking iuijs.org should redirect to iui-js.org which should
contain an overview, links to Google Code and the current content from
http://iui-js.appspot.com

> I will be updating with my progress here!
>

Cool! Thanks, again!


-- Sean

StanRB

unread,
Nov 23, 2009, 1:23:07 PM11/23/09
to iui-developers
Thanks, Remi and Sean! I am glad we are starting this. I will be
seriously looking into DocBook. It sounds like the best way to go. I
like the summary page you posted. I have my own and after I revise it
and incorporate some of yours, I will post my suggestions here. I
assume I will be freely able to use the info we already have on the
wiki? I will start by directly copy/paste-ing material so I have a
base and then populate with my text. The way I will start with this is
by dividing the whole thing by the appropriate sections, then writing
a thesis summary of each section, then expanding that summary in a
more in depth one, then developing the section. This way we will have
the base there and can slowly expand. Rather than publishing say -
just the introduction and tutorial or whatever. And it should make it
easier for other contributors to join in...

Cheers!

Stan

Sean Gilligan

unread,
Nov 23, 2009, 1:36:33 PM11/23/09
to iui-dev...@googlegroups.com
StanRB wrote:
> I assume I will be freely able to use the info we already have on the
> wiki?
Of course. It is under the terms of CC-BY-SA:
http://creativecommons.org/licenses/by-sa/3.0/

> I will start by directly copy/paste-ing material so I have a
> base and then populate with my text. The way I will start with this is
> by dividing the whole thing by the appropriate sections, then writing
> a thesis summary of each section, then expanding that summary in a
> more in depth one, then developing the section. This way we will have
> the base there and can slowly expand. Rather than publishing say -
> just the introduction and tutorial or whatever. And it should make it
> easier for other contributors to join in...
>

This is a fantastic way to get started! Would access to the wiki help
you in any way? Should we create a 'documentation project' wiki page
for collaboration in defining the scope/outline of the documentation
effort? Alternatively, if you want to go to DocBook fairly quickly, I
could create a placeholder doc in the Hg and you could 'clone' it and
make changes in your clone <http://code.google.com/p/iui/source/clones>

-- Sean

StanRB

unread,
Nov 23, 2009, 2:01:11 PM11/23/09
to iui-developers
Good suggestions. I'd rather not have access to the wiki right away -
haven't earned it yet ;)... Even though I'd appreciate a documentation
project page that I can edit personally - any way to set this up?...
Once I get it going and start on DocBook, we can proceed with
cloning ;). I don't want to be premature ;)... I feel like I'm getting
sick - cross your fingers for me to be wrong so I can work on this
over the "break"...

Cheers!

Stan

Sean Gilligan

unread,
Nov 23, 2009, 2:22:38 PM11/23/09
to iui-dev...@googlegroups.com
StanRB wrote:
> Good suggestions. I'd rather not have access to the wiki right away -
> haven't earned it yet ;)...
I'm pretty open to granting wiki access to anyone who is not a spammer,
can write reasonably well, and is willing to collaborate with other
members of the project. It's easy enough to back out bad wiki changes... ;)

> Even though I'd appreciate a documentation
> project page that I can edit personally - any way to set this up?...
>

No way to do it for just one page, I'll just have to trust you with the
whole thing... If you think it will be useful, I'll create a
DocumentationProject wiki page and you can voluntarily limit yourself to
that page. Improvements to other pages would be welcome, though.

Also, if you found any iUI documentation, articles, blog entries that
aren't on the current Introduction page send me the links or I'll let
you add them to that page yourself.

> I feel like I'm getting
> sick - cross your fingers for me to be wrong so I can work on this
> over the "break"...
>

Fingers crossed... Don't get sick!

-- Sean

StanRB

unread,
Nov 23, 2009, 2:46:10 PM11/23/09
to iui-developers
Sounds good then! Put me up on the wiki :)... I will be overdosing on
Vitamin C now - I hope it works!

Cheers!

Stan

Sean Gilligan

unread,
Nov 23, 2009, 2:52:47 PM11/23/09
to iui-dev...@googlegroups.com
StanRB wrote:
> Sounds good then! Put me up on the wiki :)...


You're good to go. I created a blank page, here:
http://code.google.com/p/iui/wiki/DocumentationProject


> I will be overdosing on
> Vitamin C now - I hope it works!
>

Good luck!

-- Sean

StanRB

unread,
Nov 23, 2009, 8:34:33 PM11/23/09
to iui-developers
On it! Feeling a bit under the weather today... Will hopefully start
tomorrow...

Thanks and cheers!

Had a productive day today at my webteam meeting - we will be
releasing any code we develop in our app publicly for iUI's
development benefit! It just has to be cleared by the CIO, but I think
it will work out. If it does - it give iUI a great chance to "recruit"
some more developers and improve...

Stan

truedat101

unread,
Dec 4, 2009, 11:54:56 AM12/4/09
to iui-developers
Great doc set proposal. Should we simply stake this out on the Wiki?

RE: documentation of Javascript Library itself, what are best
practices for JS documentation? Java itself was always at an
advantage because the JDK could generate Javadocs, so the best
practices were easily adopted and nearly universally expected that you
generate decent Javadocs with your work. In the world of Javascript
AJAX libraries, obviously you want to compress/obfuscate for
deployment for efficiency, but for the intermediate stage it is nice
to have a browsable API similar to Javadoc. A compact/obfuscated
version of iui.js can toss out the extra documentation for anyone
looking to slim things down (I did something similar to what iui's
build.xml on the jqtouch project but used the yui compressor for both
CSS and JS).

RE: documentation of the CSS, what are best practices for documenting
CSS. I guess that if you know CSS it sort of documents itself. What
do front end designers do when creating CSS intended for someone else
to go and use?

The best documentation of all is the documentation you can build into
the app. I really like the approach of combining a demo app that
shows all widgets/GUI elements used with the sample code built into
the app itself. Java used this approach with the SwingSet demo which
was very useful. Apple sort of has this with the iPhone in their
UICatalog demo. I am sure jquery has something like this... in fact,
their online documentation is quite good and might serve as a model.

Thougths, comments?

Sean Gilligan

unread,
Dec 4, 2009, 6:28:42 PM12/4/09
to iui-dev...@googlegroups.com
truedat101 wrote:
> Great doc set proposal. Should we simply stake this out on the Wiki?
>

That was the plan...

> RE: documentation of Javascript Library itself, what are best
> practices for JS documentation? Java itself was always at an
> advantage because the JDK could generate Javadocs, so the best
> practices were easily adopted and nearly universally expected that you
> generate decent Javadocs with your work.

Yeah, I'm not sure which tool to choose for this. I'd also like to find
tools for merging the CSS and JavaScript back into a single file as part
of the "build" process as well. And I'd love to find the time to try
out the Google "Closure" compiler.


>
> RE: documentation of the CSS, what are best practices for documenting
> CSS. I guess that if you know CSS it sort of documents itself. What
> do front end designers do when creating CSS intended for someone else
> to go and use?
>

I don't know but would love to hear/see...

> The best documentation of all is the documentation you can build into
> the app.

Agreed.

> I really like the approach of combining a demo app that
> shows all widgets/GUI elements used with the sample code built into
> the app itself. Java used this approach with the SwingSet demo which
> was very useful. Apple sort of has this with the iPhone in their
> UICatalog demo.

I (just barely) started something that was intended to be just that:
http://iui-js.appspot.com/test/complete.html
If anyone wants to add to it, please do.

> I am sure jquery has something like this... in fact,
> their online documentation is quite good and might serve as a model.
>

It's very good. We need to rise to the challenge.

> Thoughts, comments?
>

See above...


-- Sean



Remi Grumeau

unread,
Dec 4, 2009, 8:19:48 PM12/4/09
to iui-dev...@googlegroups.com
> I (just barely) started something that was intended to be just that:
> http://iui-js.appspot.com/test/complete.html
> If anyone wants to add to it, please do.

Based on iphone.psd i found, i had some button style. you can see them here
http://remi-grumeau.com/iphone/#_buttons
(red, disabled, grey)
Also, i had a <p> in <fieldset><div class="row"> in order to put text left aligned.

About this, i'd like to ask you guys about a PNG vs CSS question i'm asking me lately.
This rounded button with gradient style is actually based on a PNG, but it also could be done in plain CSS, for webkit (using background-image: -webkit-linear-gradient) and firefox (using background-image: -moz-linear-gradient). Both provide an alpha channel.

So my question is: would it be nice to recreate default theme buttons by CSS style or let's just keep PNG as it is ?
1. Creating those button in CSS could be quicklier and bandwidth safer since no image in downloaded - and it seems the HTML renderer use native GPU to render it
2. using a PNG is definitely simplier for theme modification/customization (if you have some image editing skills, which sounds obvious if you want to make a custom theme)

What you think ?

Remi

StanRB

unread,
Dec 5, 2009, 1:43:24 PM12/5/09
to iui-developers
So learning DocBook was in vain ;)? JK... I'll have some updates on
this coming soon. jQueary have good docs and I am certainly looking at
them. While having in-code documentation will definitely provide the
biggest benefit, what I am concentrating my efforts mostly on are
guides that can be distributed along iUI... Anyway... My questions is
- I kind of spaced out, but - where will we be hosting the docs I'm
working on? Is it all going to be on the Wiki? How will it work? I am
writing them using DocBook's schema and want to know where the files
should ultimately end up sitting... Anyway - I hope you are ready for
the holidays! I will be able to work much more on this over the break
I have. Especially the break from my girlfriend ;) (she is going to
stay with parents upstate for January)... CHeers!

truedat101

unread,
Dec 7, 2009, 11:54:29 AM12/7/09
to iui-developers
Hi Remi,

can you run some tests to see what the savings in terms of page load
times to see which method works "best" in practice? I like the idea
of the optimization. Also, is there any downside in terms of browser
compatibility (which may affect complexity of the JS/CSS)? I'm no
expert on this, so just thinking about where this might impact.

On Dec 4, 5:19 pm, Remi Grumeau <remi.grum...@gmail.com> wrote:
> > I (just barely) started something that was intended to be just that:
> >http://iui-js.appspot.com/test/complete.html
> > If anyone wants to add to it, please do.
>
> Based on iphone.psd i found, i had some button style. you can see them herehttp://remi-grumeau.com/iphone/#_buttons
> (red, disabled, grey)
> Also, i had a <p> in <fieldset><div class="row"> in order to put text left aligned.
>
> About this, i'd like to ask you guys about a PNG vs CSS question i'm asking me lately.
> This rounded button with gradient style is actually based on a PNG, but it also could be done in plain CSS, for webkit (using background-image: -webkit-linear-gradient) and firefox (using background-image: -moz-linear-gradient). Both provide an alpha channel.
>
> So my question is: would it be nice to recreate default theme buttons by CSS style or let's just keep PNG as it is ?
> 1. Creating those button in CSS could be quicklier and bandwidth safer since no image in downloaded - and it seems the HTML renderer use native GPU to render it
> 2. using a PNG is definitely simplier for theme modification/customization (if you have some image editing skills, which sounds obvious if you want to make a custom theme)
>
> What you think ?
>
> Remi
>
>  smime.p7s
> 2KViewDownload

truedat101

unread,
Dec 7, 2009, 12:09:25 PM12/7/09
to iui-developers
Hi Stanislav,

I'm thinking about we should separate the content from the
presentation for the moment. The Wiki is a great place to stake out a
content outline, get collaboration, etc. Probably, honestly, DocBook
is the right thing to do, because it can be made to produce
documentation in any format. However, absent a groundswell of desire
for anyone to start on docs yet, Wiki is a good safe start point.
Once there is a good first cut of documentation, I would suggest
organizing the documentation into the JQuery style of docs for
distribution and presentation. Docbook docs can be brought in at any
point (under version control) to do things the right way. The key I
always stress is to focus on content before worrying about
presentation. We will have a fair amount of writing to do to get docs
to meet the jquery standard.

So, HTML docs are great, and these can eventually live in the doc tree
that ships with the IUI distro. And why not use IUI itself as the
presentation front end for the docs? This give several benefits: show
off IUI capability, allow mobile and desktop browsing of the docs,
allow doc + example + code to live in the same place.

So maybe 1st cut:
WIKI-> IUI/HTML docs

And later:
DOCBOOK->IUI/HTML docs (for IUI doctree, and for online documentation)

Thoughts?

Sean Gilligan

unread,
Dec 7, 2009, 2:12:13 PM12/7/09
to iui-dev...@googlegroups.com
truedat101 wrote:
> I'm thinking about we should separate the content from the
> presentation for the moment. The Wiki is a great place to stake out a
> content outline, get collaboration, etc. Probably, honestly, DocBook
> is the right thing to do, because it can be made to produce
> documentation in any format. However, absent a groundswell of desire
> for anyone to start on docs yet, Wiki is a good safe start point.
>

Agreed.

> The key I
> always stress is to focus on content before worrying about
> presentation.
Agreed.

> We will have a fair amount of writing to do to get docs
> to meet the jquery standard.
>
> So, HTML docs are great, and these can eventually live in the doc tree
> that ships with the IUI distro. And why not use IUI itself as the
> presentation front end for the docs?

I've seen at least two instances of iUI being used for API docs:

1) iDoc
Info: http://www.appsafari.com/dev/2572/javadocs-by-idoc/
Sample: http://www.adamhoughton.com/iDoc/

2) iPhoneRDocTemplate
GitHub: http://github.com/glejeune/iPhoneRDocTemplate
Sample: http://gregoire.lejeune.free.fr/rdoc_iphone/


Stan (or anyone else), don't let DocBook hold you up. If you write the
docs in HTML/HTML5 or even on the wiki, that would be a great start.

-- Sean

Remi Grumeau

unread,
Dec 7, 2009, 2:54:07 PM12/7/09
to iui-dev...@googlegroups.com, truedat101
the compatibility is ok since both firefox and webkit can do gradients.
Only IE mobile on windows based smartphones could be a problem but since it's not even supporting HTML5 and CSS3 … :-S

Actually, it's also a downloading time / bandwidth saving / pages loading question since the CSS file is loaded on website startup and not related images, having those buttons done in plain CSS do not need to download additional contents (PNGs here, which is the worse file-size optimized format). If your 3G/mobile signal is not good, this could be great.
When this button image has been loaded once and so stored in the browser cache, i assume the winner of PNG vs CSS game would still be CSS but from milliseconds only.

I have done a few tests here
http://remi-grumeau.com/iphone/buttons.php#_buttons
first one is the PNG, second is made with 3 border definitions : top, right&left, bottom. Last one use a webkit border image property using linear gradient as image.
Issue : border image and opacity / radius :-S
I'll try to work this out with this example i found: http://www.zenelements.com/blog/images/web-tutorials/css3-introduction/border-color-II.gif
Will keep you informed but it seems gradient border and radius border are not supposed to work together…

Remi

> --
>
> You received this message because you are subscribed to the Google Groups "iui-developers" group.
> To post to this group, send email to iui-dev...@googlegroups.com.
> To unsubscribe from this group, send email to iui-developer...@googlegroups.com.

> For more options, visit this group at http://groups.google.com/group/iui-developers?hl=en.
>
>


Remi Grumeau
(+33) 663 687 206
http://www.remi-grumeau.com

StanRB

unread,
Dec 8, 2009, 9:34:43 AM12/8/09
to iui-developers
Ok then! DocBook is getting a back seat... Going to expand on the Wiki
for now...

StanRB

unread,
Dec 21, 2009, 4:39:32 PM12/21/09
to iui-developers
Page has been updated and if I wasn't sick there would be more info :
(... Going to try to type some more stuff up tonight...

Stan

Sean Gilligan

unread,
Dec 22, 2009, 4:52:46 PM12/22/09
to iui-dev...@googlegroups.com
StanRB wrote:
> Page has been updated and if I wasn't sick there would be more info :
> (... Going to try to type some more stuff up tonight...
>

Thanks, Stan!

Looks ambitious ;) I should have time to comment on it next week.

-- Sean

StanRB

unread,
Dec 26, 2009, 5:42:20 PM12/26/09
to iui-developers

Hopefully it will slowly progress :)... Wait till after the next
update for comments. Thanks, Sean!

Cheers!

StanRB

unread,
Dec 29, 2009, 2:33:41 PM12/29/09
to iui-developers
A few more words of description added. DocBook file was started...
Sean - next steps? How can I make this accessible for others to review/
contribute to? Comments on the ToC? Should you make space for the
mercurial managed DocBook files in the iUI source and then I make a
clone to work on?

Stan

Sean Gilligan

unread,
Dec 29, 2009, 3:23:49 PM12/29/09
to iui-dev...@googlegroups.com
StanRB wrote:
> Sean - next steps? How can I make this accessible for others to review/
> contribute to? Comments on the ToC?
Coming (from me) by this weekend.

> Should you make space for the
> mercurial managed DocBook files in the iUI source and then I make a
> clone to work on?
>

Yes. A placeholder is here:
http://code.google.com/p/iui/source/browse/docs/iUIGuide.xml
Clone away!

Maybe we want a "book" not an "article" we can change that at any time.
I can hook up some basic Java XSLT processing tools fairly easily
if/when needed. We also may want to use XInclude to put
chapters/sections in separate files to make coordination a little easier.

-- Sean

Andrea Picchi

unread,
Dec 29, 2009, 5:56:49 PM12/29/09
to iui-developers
I quote Remi, nice planning.

StanRB

unread,
Dec 29, 2009, 8:14:23 PM12/29/09
to iui-developers
It's what I was going to suggest :)... As of now I have it set up as a
book and have sections in separate files. It will help a lot in the
future. I'm considering splitting even further down. Will come back
here with my plan and some questions as soon as I have some time...
Maybe after I have some more physical files I can send them to you and
then set up the google code part. Sorry for making you quickfire... :/

Andrea Picchi

unread,
Dec 30, 2009, 6:18:03 AM12/30/09
to iui-developers
On Dec 5, 2:19 am, Remi Grumeau <remi.grum...@gmail.com> wrote:
> So my question is: would it be nice to recreate default theme buttons by CSS style or let's just keep PNG as it is ?
> 1. Creating those button in CSS could be quicklier and bandwidth safer since no image in downloaded - and it seems the HTML renderer use native GPU to render it
> 2. using a PNG is definitely simplier for theme modification/customization (if you have some image editing skills, which sounds obvious if you want to make a custom theme)

I agree 100%, we need to use all the CSS3 possible to reduce loading
time and optimize the code.
Who will do it? If you need me, drop a line!

Remi Grumeau

unread,
Dec 30, 2009, 8:07:33 PM12/30/09
to iui-dev...@googlegroups.com
Thx ;))
Any suggestions btw ? (for ex sub-sub parts)

Could sounds funny but … any plan for this doc to be accessible via a webapp based on iUI ? :)

> For more options, visit this group at http://groups.google.com/group/iui-developers?hl=en.
>
>

Remi Grumeau

unread,
Dec 30, 2009, 8:19:49 PM12/30/09
to iui-dev...@googlegroups.com
Hi Andrea,

I attended to recreate most of the PNG effect using PNG.
The problem is that you definitely can't get the same level of details, specially for buttons (tail for the back, gradient in borders of buttons, …)
I should publish what i have already btw. Want a copy by mail and enhance what i've start ?

Remi

> --
>
> You received this message because you are subscribed to the Google Groups "iui-developers" group.
> To post to this group, send email to iui-dev...@googlegroups.com.
> To unsubscribe from this group, send email to iui-developer...@googlegroups.com.

> For more options, visit this group at http://groups.google.com/group/iui-developers?hl=en.
>
>

Sean Gilligan

unread,
Dec 30, 2009, 8:29:29 PM12/30/09
to iui-dev...@googlegroups.com
Remi Grumeau wrote:
> Thx ;))
> Any suggestions btw ? (for ex sub-sub parts)
>
> Could sounds funny but � any plan for this doc to be accessible via a webapp based on iUI ? :)
>

It's been mentioned before and I've been thinking about it.

I'd love to see some extensions to the DocBook XSL stylesheets to
generate an iUI version. I'm not sure how much work it would be or if
anyone in the DocBook community would be interested in helping, but it
would be cool to be able to take any DocBook doc and generate an iUI
version.

DocBook has support for ePub:
http://toc.oreilly.com/2008/06/open-source-docbook-xsl-experimental-epub-support-released.html
ePub was experimental in DocBook XSL 1.74.0 -- I'm not sure how well it
works in 1.75.2 (latest version)

I haven't worked much with DocBook in the last couple of years, so I'm
not sure how it's been improved in that time. The XSL stylesheets are
very powerful and can be customized/extended in many ways. The core
HTML/XHTML stylesheets allow output of a single HTML file or "chunked"
HTML with one file per chapter or section. If you've used DocBook you
can easily recognize on-line documentation that was produced with these
stylesheets.

Working with the XSL is difficult though. The core HTML/XHTML
stylesheets don't produce clean, modern CSS-based markup and the DocBook
team is working to do that, but have acknowledged that the change is not
a small task and have not committed to a schedule for completion.

I'd like to see XSL to produce clean HTML5 (since it is partly based on
DocBook) but that must be even further out. (It would also be cool to
see XSL that makes DocBook from HTML5)

It would seem that the best approach for generating an iUI webapp/site
from DocBook would be to use the chunked output and alter the styles to
work with iui.css and iui.js. The links from the main document to the
chunks would then be iUI Ajax (AHAH) links.

I'm not sure how much the existing styles and attributes would interfere
with iUI or how much work it would be to modify the XSL to produce
(X)HTML/CSS that does work with iUI. It might also be possible to write
some XSL that postprocesses the (X)HTML generated by the existing
stylesheets.

I'll post something to the DocBook list (I used to post on the list
years ago, but am a lurker there these days)

-- Sean

p.s. AHAH is defined here: http://microformats.org/wiki/rest/ahah

Remi Grumeau

unread,
Dec 30, 2009, 8:36:31 PM12/30/09
to iui-dev...@googlegroups.com
Tough question/task so … :S

Remi

Le 31 déc. 2009 à 02:29, Sean Gilligan a écrit :

> Remi Grumeau wrote:
>> Thx ;))
>> Any suggestions btw ? (for ex sub-sub parts)
>>

>> Could sounds funny but … any plan for this doc to be accessible via a webapp based on iUI ? :)

Reply all
Reply to author
Forward
0 new messages