Hi Kasun,
Did you meant the typewith.me <http://typewith.me> etherpad we
maintained? Seems it's down currently for upgrades.
http://www.downforeveryoneorjustme.com/http://typewith.me
Ah, OK. I thought David had moved it to another place from Typewith.me.
Thanks!
BTW, a blog post I wrote covering Moratuwa Google Summer of Code session
made to Google Open Source Blog. :)) There's tiny mention of DocBook
too. It looks kinda like a contribution from DocBook!
Congratulations! Got a URL for me to look at?
Cheers,
Stefan
On Thu, Apr 5, 2012 at 5:30 PM, Stefan Hinz <[email protected]
<mailto:[email protected]>> wrote:
Hi Kasun, David,
What happened to the online version of our below list?
I'm just about to help Visitha get his application finalized, and
wanted to have a look at that list on the web. I'm sure I bookmarked
it, but all I can find are
http://docbook.xmlpress.net/tiki-index.php?page=Ideas2012#Webhelp
(just the executive summary) and
http://docbook.xmlpress.net/tiki-index.php?page=WebHelpIdeas (a
mostly unordered list).
Any ideas where the ordered list below can be found?
Cheers,
Stefan
On 30.03.2012 04:18, Kasun Gajasinghe wrote:
Hi all,
The mentors for webhelp has come up with the following priority
feature list to be expected from the possible students for webhelp
[1]. If you are eligible to participate, and like to contribute to
DocBook, and WebHelp, then join with us. The list provided might
look overwhelming at first. For a new user, it always will be. :-)
But by the time, it'll be OK. Unless otherwise specified, almost
all the tasks expected are moderate. I would classify only one to
have a bit of more research involved. The possible students can of
course discuss about these and come to an agreement on what needs
to be implemented which will match with our objectives, and
students current skills plus skills that s/he like to develop.
During the proposal period, only keep your focus on first 5 tasks
here and (6) a. Please don't hesitate to ask questions you may
have regarding the provided tasks, and DocBook in general. There's
still time to discuss and submit a proposal. The proposal deadline
is April 6th, 19:00 UTC.
[1] http://docbook.xmlpress.net/tiki-index.php?page=Ideas2012#Webhelp
=============
1. *Provide an example Makefile as an alternative to the ant script*
1. Removal of the dependency on Ant. Make WebHelp build with
make, so that people using make and xsltproc can build WebHelp.
2. This would be a good starter task for the student to get a
feel for how thing work.
3. There might be a sample Makefile to get the implementor of
this going, or to give the student some ideas.
2. *Parameterize list of files to exclude from indexing.
*Currently it's hard coded that we don't index index.html and
ix01.html (the legal notice and index topics). It should be
smarter and automatically not index the index file even if
it's not named ix01.html. Add to the indexer the ability to
specify a list of files or file patterns not to index.
Currently it does not index index.html or ix01.html, which is
generally appropriate, but it should be up to the user to decide.
3. *Search functionality improvements*
1. Add other search options:
1. Add an option to create webhelp as a webapp using Lucene as
the search engine.
2. Strip quotes from search queries (if a user searches for "foo
bar" with quotes, strip the quotes). Currently a quoted search
shows no results.
1. That would be a relatively easy and quick fix, and would add a
lot of benefit.
4. *Improve image copying functionality to deal with xincluded
content.* - This could be blocker for some projects, and it
doesn't WYSIWYG IDE friendly. Current image copying feature is
very primitive.
* This will be a bit of a mindbender for the student, but a good
exercise. We'll provide a good demo doc that shows what is needed.
* Why issue are we trying to address here? This is more of an
issue if you make extensive use of xinclude. Imagine you
xinclude some file from some random place on your system and
the DocBook content includes a fileref with a relative path to
an image. The build system has to copy the image into the
webhelp output dir AND adjust the path to the image to it's
new home. Ideally this should be robust enough to handle
whatever weird and random thing a writer might do. I've
implemented a solution for this that could be adapted.
5. *Enhanced configurability, together with improved readability
of the code* (webhelp.xsl). These issues are somewhat
interwoven; being able to make WebHelp more configurable is
hard when the code is hard to parse.
* Moving the params and gentext strings into the normal place in
the xsls. Seems a docbook developer already started doing this.
* We'll provide some specific instructions for this stuff on
what needs to be done.
6. *EASY Tasks*
1. Remove the "content" folder in WebHelp output (and thus in
the template). - Easy
1. This is fairly easy work. Further, this could be a sub-task
under (parameterize list of files to exclude from indexing.)
2. This could be implemented after (2).
2. Make it possible to include the document title in the html
page's <head><title> without also having the document title
appear in the search results summary.
1. Adding this task here is arguable. Would this be configurable?
If not, would everyone regard this an improvement?
3. Make sure we give an informative message if they come to the
page using NoScript or with cookies disabled.
1. NoScript is all over the place these days, so the informative
message could even be "please configure NoScript to allow
JavaScript for this page".
*Low Priority*
1. *Add autocompletion to the search box (This was suggested by
one of the students and is an interesting idea).*
1. This could of lower priority. Shall we keep this to the end? `
2. If someone dies to implement this, why not, but otherwise it's
a "nice to have" item to the largest possible extent. :-)
2. *Make the toc width adjustable* (is this even possible?)
1. It's possible, generally. But should look whether this can be
integrated into webhelp design. low prioriy!
3. *Fix some bugs:*
1. Sidebar does not remain collapsed when clicking next/previous
2. Improve performance in IE 8/9 (remove need for "treat as IE 7
directive")
3. Adjust titlepage templates so abstract is not shown by default.
=============================
--
~~~*******'''''''''''''*******~~~
*Kasun Gajasinghe*
Software Engineer; WSO2 Inc.; http://wso2.com <http://wso2.com/>,
/linked-in: /http://lk.linkedin.com/in/gajasinghe/
/
/blog: //http://blog.kasunbg.org/ <http://blog.kasunbg.org/>
/
twitter: //http://twitter.com/kasunbg/
--
Cheers,
Stefan Hinz<[email protected]> <mailto:[email protected]>, MySQL
Documentation Manager
Phone:+49-30-82702940 <tel:%2B49-30-82702940>, Fax:+49-30-82702941
<tel:%2B49-30-82702941>,http://dev.mysql.com/doc
ORACLE Deutschland B.V.& Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
--
~~~*******'''''''''''''*******~~~
*Kasun Gajasinghe*
Software Engineer; WSO2 Inc.; http://wso2.com <http://wso2.com/>,
/linked-in: /http://lk.linkedin.com/in/gajasinghe/
/
/blog: //http://blog.kasunbg.org/ <http://blog.kasunbg.org/>
/
twitter: //http://twitter.com/kasunbg/
--
Cheers,
Stefan Hinz <[email protected]>, MySQL Documentation Manager
Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc
ORACLE Deutschland B.V.& Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz
General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
