Quick start page
Mikkel Høgh
I've been working a bit ion a customisation of the quick start page
(the one that shows up when you've created a new TG project - "Are you
ready to gear up?"), and I have a few considerations.
As it is now, changing the quick start page means changing welcome.kid
and possibly master.kid, which will probably break some of our
tutorials, since to make the page really spiffy, we're probably going
to have to use CSS and perhaps other advanced layout techniques. So
what to do? Rails have a static HTML file with their start page, but
isn't it rather complicated to have TG return flat HTML files instead
of template-generated goodness?
We could also leave it out of the project files and instead have it as
a part of the TG files (those in site-packages) and then have the
default controllers.py expose those files instead
(@expose(template="turbogears.quickstart")), but that also needs
explanation. The benefit of this, however, is that we can make the file
as spiffy as we want to, without confusing the user with lots and lots
of CSS and strange layout tricks.
At any rate, that's my idea, although I'm a bit uncertain if this it's
a good one :)
Kevin Dangoor
> As it is now, changing the quick start page means changing welcome.kid
> and possibly master.kid, which will probably break some of our
> tutorials, since to make the page really spiffy, we're probably going
> to have to use CSS and perhaps other advanced layout techniques. So
> what to do? Rails have a static HTML file with their start page, but
> isn't it rather complicated to have TG return flat HTML files instead
> of template-generated goodness?
welcome.kid is effectively a static file. It has one dynamic element
and extends master.kid. if you think there are problems putting some
things in master.kid, just put them in welcome.kid
I think all of the files should be included in the quickstarted
project so that the user can really start tweaking from whatever is
on the page.
I do fully intend for TG apps to be skinnable down the line, which
will give us some other nice options. If you look at the page you get
with Rails, it's just a bit prettier and more useful a starting
point. (Take a look at that new WebFaction screencast and you'll see
what I mean)
> We could also leave it out of the project files and instead have it as
> a part of the TG files (those in site-packages) and then have the
> default controllers.py expose those files instead
> (@expose(template="turbogears.quickstart")), but that also needs
> explanation. The benefit of this, however, is that we can make the
> file
> as spiffy as we want to, without confusing the user with lots and lots
> of CSS and strange layout tricks.
>
> At any rate, that's my idea, although I'm a bit uncertain if this it's
> a good one :)
A quickstart user is always free to delete the CSS and remove
references to it. Once we have skins for apps, it'll be a lot clearer
how to package the overall look up in a reusable/customizable way.
Kevin
Mikkel Høgh
and I've worked a bit with a simple, yet compelling design. I've not
finished either, since I'd like your opinion first :)
gas...@gmail.com
But currently the content is too wordy :P
I wonder if "Congratulations!" or the "check sign" messages could be
more "fancy" (as a flash status message)?
http://www.splee.co.uk/2005/11/23/fancy-status-messages-using-tg_flash/
--
Fred
Kevin Dangoor
That's certainly a big improvement in appearance. You might want to
use a different "under the hood" logo:
http://www.docudo.org/static/images/under_the_hood_blue.png
We need a new collection of those sometime, but at least that one is
better than the old one.
Kevin
Jorge Vargas
I like it, is it me of the 2. is not lined up correctly?
stick...@gmail.com
>
> I like it, is it me of the 2. is not lined up correctly?
>
It's correct, I just checked it my my on screen ruler :-D
I think its an optical illusion since there is no block of text next to
the number 2 becasue i thought it was off also.
I like the design also, but i do aggree the 'Congratulations' text will
need a bit of re-wording.
Mikkel Høgh
> But currently the content is too wordy :P
Yeah, I'm sorry - English is only my second language, and sadly I don't
have the opportunity to practise it all that much.
Actually, I hoped someone would be able to come up with some better
text :)
> I wonder if "Congratulations!" or the "check sign" messages could be
> more "fancy" (as a flash status message)?
> http://www.splee.co.uk/2005/11/23/fancy-status-messages-using-tg_flash/
That site is horribly broken in my browser, but I managed to figure it
out. I've foregone the opacity, it makes the image look to bland, but
otherwise, I've implemented it. It is only a static page so there's no
AJAX'y stuff there yet - besides, I'm not all that good at AJAX
anyways.
I looked at the other suggestions you guys came with, and I've tweaked
the layout a bit and juggled some fonts. Let me know what you think -
the URL is still http://revelation.dk/qs/index.html
Kaan
> Actually, I hoped someone would be able to come up with some better
> text :)
How's this:
Congratulations!
Your TurboGears application is up and running.
Your journey into the land of rapid web application development has
started. If you're wondering where to go from here, check out the list
below.
Getting started
Here are some of the steps you can take to build your TurboGears app:
1. Create your model
TurboGears is pre-configured to use SQLite so you can start development
immediately. If you want to use a different database, edit the dev.cfg
file to uncomment and fill in one of the example dburi's.
You can now create your model directly in model.py or you can have the
Toolbox do it for you! Remeber to run 'tg-admin sql create' to create
the tables in the database.
2. Take control
Edit your controllers.py and take use CherryPy to make mapping your
application to urls as easy as using Python objects. See the
documentation for how you can create your url tree, handle form data,
validate input, change the content type returned and create more
dynamic urls.
3. Design your view
Head on over to the templates directory to edit this page or create
your own templates with Kid. Edit your master.kid template to include
stuff on every page of your site. Static content, such as css,
javascript and images can go in the static directory.
For the quickest, easiest dynamic content creation, be sure to look
into widgets.
4. And more...
There are many cool things you can do to take your application to the
next level. Make AJAX easy with Mochikit and JSON, take advantage of
the easy identity framework, schedule recurring tasks, easily write
tests for your app and more.
If you create something cool, consider contributing back to the
community. TurboGears is an open source project whose vitality comes
from developers like you.
Good luck with your web development!
Jorge Vargas
Mikkel Høgh wrote:
> Actually, I hoped someone would be able to come up with some better
> text :)
How's this:
some comments
Congratulations!
Your TurboGears application is up and running.
Your journey into the land of rapid web application development has
started. If you're wondering where to go from here, check out the list
below.
Getting started
Here are some of the steps you can take to build your TurboGears app:
1. Create your model
TurboGears is pre-configured to use SQLite so you can start development
immediately. If you want to use a different database, edit the dev.cfg
file to uncomment and fill in one of the example dburi's.
TurboGears is pre-configured to use SQLite (if you already have it's python bindings install) so you can start development
immediately, If you want to use a different database, go edit the dev.cfg and follow the example dburi's.
You can now create your model directly in model.py or you can have the
Toolbox do it for you! Remeber to run 'tg-admin sql create' to create
the tables in the database.
You can now create your model by editing model.py or take advantage of the develoment tools in the Toolbox "tg-admin toolbox", after your done with the edting Remeber to save and run 'tg-admin sql create' so the model is transfer to the Database
2. Take control
Edit your controllers.py and take use CherryPy to make mapping your
application to urls as easy as using Python objects. See the
documentation for how you can create your url tree, handle form data,
validate input, change the content type returned and create more
dynamic urls.
3. Design your view
Head on over to the templates directory to edit this page or create
your own templates with Kid. Edit your master.kid template to include
stuff on every page of your site. Static content, such as css,
javascript and images can go in the static directory.
stuff?
Static content..... MUST go, although we should say should go in the static directory.
For the quickest, easiest dynamic content creation, be sure to look
into widgets.
add Check out the widget browser on the toolbox
4. And more...
There are many cool things you can do to take your application to the
next level. Make AJAX easy with Mochikit and JSON, take advantage of
the easy identity framework, schedule recurring tasks, easily write
tests for your app and more.
deployment with setuptools?
If you create something cool, consider contributing back to the
community. TurboGears is an open source project whose vitality comes
from developers like you.
maybe something like if for any reason you can't contribute just drop us a line so we know our work is put to good use
Kaan
drivers and such because the application would have failed to startup
if those were missing, right?
Here's my version: http://www.evil-robots.net/tgwelcome/index.html
Any more feedback? What do you all think of the links?
I think this should eventually be posted in main group, and eventually
trac.
-Kaan
Jorge Vargas wrote:
> On 6/23/06, Kaan <Kubla...@gmail.com> wrote:
> >
> >
> > Mikkel Høgh wrote:
> > > Actually, I hoped someone would be able to come up with some better
> > > text :)
> >
> > How's this:
>
>
> some comments
>
> Congratulations!
> >
> > Your TurboGears application is up and running.
> >
> > Your journey into the land of rapid web application development has
> > started. If you're wondering where to go from here, check out the list
> > below.
> >
> > Getting started
> >
> > Here are some of the steps you can take to build your TurboGears app:
> >
> > 1. Create your model
> > TurboGears is pre-configured to use SQLite so you can start development
> > immediately. If you want to use a different database, edit the dev.cfg
> > file to uncomment and fill in one of the example dburi's.
>
>
> TurboGears is pre-configured to use SQLite (if you already have it's python
> bindings install) so you can start development
> immediately, If you want to use a different database, go edit the
> dev.cfgand follow the example dburi's.
> ------=_Part_145_17678960.1151103305173
> Content-Type: text/html; charset=ISO-8859-1
> Content-Transfer-Encoding: quoted-printable
> X-Google-AttachSize: 4446
gas...@gmail.com
Nice shot :D,
its very comprehensive,
but it seems too much infomation too chew in the quickstart page.
let's cut the volume...
I think 2 lines description after each title is more affordable...we
can link further info elsewhere anyway.
{{{
1.Create your model
Start development immediately with pre-configured SQLite db,
or edit the dev.cfg file to use a different database.
2. Build your controllers
Edit your controllers.py file and build your application urls with
Python objects.
[See the documentation] (A link point to online/offline doc list)
3. Design your view
Edit this page in the "templates" directory
Edit Static content (css, javascript and images) in the "static"
directory.
[See the documentation] (A link point to online/offline doc list)
4. And more...
There are many cool things you can do to take your application to the
next level.
Make AJAX easy or take advantage of the widgets, identity, unit test.
And don't forget to try the Toolbox.
[See the documentation] (A link point to online/offline doc list)
Good luck making your killer app!
If you create something cool, consider contributing back to the
community.
TurboGears is an open source project whose vitality comes from users
and developers like you.
}}}
--
Fred
Kevin Dangoor
On Jun 24, 2006, at 4:38 AM, gas...@gmail.com wrote:
>
> Hi Kaan :
>
> Nice shot :D,
> its very comprehensive,
> but it seems too much infomation too chew in the quickstart page.
> let's cut the volume...
>
> I think 2 lines description after each title is more affordable...we
> can link further info elsewhere anyway.
I think Fred's right on this point. The details on how to get things
done should be elsewhere. We could put a companion page on the site
that has some details for each step with a link to even more
information related to the steps.
Kevin
Jorge Vargas
Hi Kaan :
Nice shot :D,
its very comprehensive,
but it seems too much infomation too chew in the quickstart page.
let's cut the volume...
I think 2 lines description after each title is more affordable...we
can link further info elsewhere anyway.
yes but some things must stay there for example
{{{
1.Create your model
Start development immediately with pre-configured SQLite db,
or edit the dev.cfg file to use a different database.
you have to install your own db, many newbies in the mailing list think easy_install will set their db, which from their point of view is not that insane
--------------
in general I think Kaan's doc is ok if we make it "fit in one page"
Mikkel Høgh
here.
I've also tweaked the design quite a bit. The graphics need some work -
the bullets should be properly aligned and the OK-thingie needs to get
its background changed, but otherwise, I'd say it's shaping up...
Kaan
Here's another stab at it:
http://www.evil-robots.net/tgwelcome/index2.html
Kaan
than mine. It must be those gigantic list item headers.
Maybe we can merge our efforts after we have some more opinions on
both.
Mikkel Høgh
Kaan wrote:
> Maybe we can merge our efforts after we have some more opinions on
> both.
I think that it would be better if we collaborate here. I've made the
text I have now based on what you posted earlier, so if you think I
should change anything about it, just post it here... Having several
separate html-files across different hosts will just make this a lot
harder. I plan to make a Bazaar repository of it, if only for my own
benefit...
Jorge Vargas
Kaan wrote:
> Maybe we can merge our efforts after we have some more opinions on
> both.
I think that it would be better if we collaborate here. I've made the
text I have now based on what you posted earlier, so if you think I
should change anything about it, just post it here...
yea I agree
Having several
separate html-files across different hosts will just make this a lot
harder. I plan to make a Bazaar repository of it, if only for my own
benefit...
I was about to propose a svn repo for such a dificult job :)
now seriously we will never agree 100% on the text, so lets try to merge them instead of forking them :)
Mikkel Høgh
Since these files is just flat HTML/CSS files and images, we can't
really check them into SVN until they've been converted into templates
etc.
The reason I haven't converted them yet is that I have a concerns with
regard to the format and having it all spread all over the trunk would
probably make this brainstorming harder.
I originally planned to convert it to TG format and make a patch for
trunk when it was finished, but it seems we could need the benefit of
VCS right now :)
I suppose I can make a SVN repo for it myself, but I haven't had any
experience with that, and since my password for textdrive is at my
computer at the office, I'd have to wait until monday anyways, so if
anyone has a better solution, please do tell. Besides, setting up SVN
seems a bit like overkill for a job of this size :)
Whatever you do, I'd prefer if you base your work on the file I've made
as it is now, since I've hacked a lot at the CSS to make it /just so/.
It's not that I want to monopolise this task, but I'd rather not see my
work go to waste :)
Mikkel Høgh
down lately... :/
Kaan
-Why the gigantic list headings in the getting started section? They
take up space and make the document look more imposing than it actually
is.
-Where did the square around the checkmark image come from? Maybe the
alpha channel of that image didn't work like you thought. Anyways, I
think it looked nicer and cleaner before.
-I added a python languange link on the links sidebar to mine. Also,
I'm seeing a space at the beginning of the 'Mailing List' link.
-I like my first two paragraphs better. In the first paragraph, I don't
really feel the sentance 'You can use TurboGears to create all kind of
web content, especially AJAX powered applications, providing real-time
interactive content to your users' means much. It's the welcome page,
right? We're done with our advertising, so let's just help them on
their way.
-I think my second paragraph (right after the getting started) is
friendlier.
-Can we mention model.py and Toolbox in the model section? I think it'd
work if you make what you have there into one paragraph, and then add
the sentance from my page mentioning them both. We should probably
mention installing the python interface of the database along with the
backend, too.
-Does TG work if you don't have sqlite installed?
-I'd get rid of the first sentence in the views section.
-Can we still include my 'join us' blurb? I think that's important.
-Should be 'reload' instead of 'reloading' in the infobox in the end.
Here's how I would do the text: Note that Turbogears will automatically
reload itself when you modify your project in development mode. Refresh
your browser to see the changes.
gas...@gmail.com
I've some questions for thought:
1. How about have a consist look and feel within the tg framework (in
start page and in tg toolbox), currently start-page and toolbox has not
much in common.
2. The title bar is too heavy, it's awesome but provide less message
usefull for user.
3. Is it possible to see most of start page infomation in one screen
(without scroll)?
--
Fred
gas...@gmail.com
To converge scripts, I'v put a Request for Comment in trac
http://trac.turbogears.org/turbogears/wiki/QuickStart
Some extra notes are laid in the script(such as "reload" info), they
can be shown while Hover the area.
If you have better idea to change script, change it,
and then leave Comment on "Comment about this change (optional):"
field.
if some debate for this change, I'll post it on maillist and we can
discuss it.
--
Fred