Mailing List Archive: ModPerl: Docs-dev

the search is working now

Index | Next | Previous | View Threaded

stas at stason

Feb 6, 2002, 10:02 PM

Post #1 of 11 (808 views)
Permalink

the search is working now

Thanks to Bill now we have the search working :)!!! It's really cool as
it points directly to the section where the match has happened, so we
don't need to create the split version of the site.

Play with it here:
http://perl.apache.org/preview/modperl-site/

There are still a bunch of issues in TODO, especially making it better
understand Perl queries. But it's a great start, since the search is
already useful. Give it a whirl.

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

moseley at hank

Feb 6, 2002, 10:20 PM

Post #2 of 11 (790 views)
Permalink

Re: the search is working now [In reply to]

At 01:02 PM 02/07/02 +0800, Stas Bekman wrote:
>Play with it here:
>http://perl.apache.org/preview/modperl-site/

And feel free to adjust the search.tt template. get rid of the swish-e
logo, the error message (such as "Please enter a query string") is too big,
and the "Results for.." bar is not the best color.

How about some logic in the template to remove the global search box from
the search results page (and maybe the navigation and src and pdf icons).

Should the search box, pdf/src and navigation be above the big title bar???
Seems like those things are more global in nature (in that they are on
most pages) but the title is for that specific page. Just looks a bit odd
to me.

--
Bill Moseley
mailto:moseley [at] hank

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

stas at stason

Feb 6, 2002, 10:25 PM

Post #3 of 11 (789 views)
Permalink

Re: the search is working now [In reply to]

Bill Moseley wrote:
> At 01:02 PM 02/07/02 +0800, Stas Bekman wrote:
>
>>Play with it here:
>>http://perl.apache.org/preview/modperl-site/
>>
>
> And feel free to adjust the search.tt template. get rid of the swish-e
> logo, the error message (such as "Please enter a query string") is too big,
> and the "Results for.." bar is not the best color.
>
> How about some logic in the template to remove the global search box from
> the search results page (and maybe the navigation and src and pdf icons).

Yeah, I thought about this. I'm not sure how to tell the template to do
a different thing. What's the rule? Ideas? Must be some config argument.

> Should the search box, pdf/src and navigation be above the big title bar???
> Seems like those things are more global in nature (in that they are on
> most pages) but the title is for that specific page. Just looks a bit odd
> to me.

The search/prev|next are global, I agree. Not the pdf/src download widgets.

So sure I can see search/prev/next moving elsewhere. What about pdf/src?

--

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

moseley at hank

Feb 6, 2002, 11:17 PM

Post #4 of 11 (791 views)
Permalink

Re: the search is working now [In reply to]

At 01:25 PM 02/07/02 +0800, Stas Bekman wrote:
>> How about some logic in the template to remove the global search box from
>> the search results page (and maybe the navigation and src and pdf icons).
>
>Yeah, I thought about this. I'm not sure how to tell the template to do
>a different thing. What's the rule? Ideas? Must be some config argument.

Easy. Add to search/search.tt

[% META nosearchbox = 1 %]

Now you have something to test in the templates.

>> Should the search box, pdf/src and navigation be above the big title bar???
>> Seems like those things are more global in nature (in that they are on
>> most pages) but the title is for that specific page. Just looks a bit odd
>> to me.
>
>The search/prev|next are global, I agree. Not the pdf/src download widgets.
>
>So sure I can see search/prev/next moving elsewhere. What about pdf/src?

I'm running out of time until Friday. I assume it's an easy template
change to move the title below all that stuff? Even though the pdf/src
widgets are directly related to that page they are still common page
elements, so they might not look that bad. I'll just have to take a look
when I get a few more minutes.

--
Bill Moseley
mailto:moseley [at] hank

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

stas at stason

Feb 7, 2002, 12:23 AM

Post #5 of 11 (794 views)
Permalink

Re: the search is working now [In reply to]

Bill Moseley wrote:
> At 01:25 PM 02/07/02 +0800, Stas Bekman wrote:
>
>>>How about some logic in the template to remove the global search box from
>>>the search results page (and maybe the navigation and src and pdf icons).
>>>
>>Yeah, I thought about this. I'm not sure how to tell the template to do
>>a different thing. What's the rule? Ideas? Must be some config argument.
>>
>
> Easy. Add to search/search.tt
>
> [% META nosearchbox = 1 %]
>
> Now you have something to test in the templates.

Nope, not easy. The rendering of searchresults.html template happens at
build time. So this variable from search.tt is not available.

>>>Should the search box, pdf/src and navigation be above the big title bar???
>>> Seems like those things are more global in nature (in that they are on
>>>most pages) but the title is for that specific page. Just looks a bit odd
>>>to me.
>>>
>>The search/prev|next are global, I agree. Not the pdf/src download widgets.
>>
>>So sure I can see search/prev/next moving elsewhere. What about pdf/src?
>>
>
> I'm running out of time until Friday. I assume it's an easy template
> change to move the title below all that stuff? Even though the pdf/src
> widgets are directly related to that page they are still common page
> elements, so they might not look that bad. I'll just have to take a look
> when I get a few more minutes.

not sure, what's the best way yet, but sure play with it and at the end
we will pick the one that we all agree on.

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

moseley at hank

Feb 7, 2002, 6:54 AM

Post #6 of 11 (798 views)
Permalink

Re: the search is working now [In reply to]

At 03:23 PM 2/7/2002 +0800, Stas Bekman wrote:
>Bill Moseley wrote:

>>>Yeah, I thought about this. I'm not sure how to tell the template to do
>>>a different thing. What's the rule? Ideas? Must be some config argument.
>>>
>>
>> Easy. Add to search/search.tt

Ah, that's right. That's one reason why I was suggesting that the final
site is built with ttree instead of DocSet. ;)

searchresults.tmpl is built when DocSet is running. Maybe DocSet could use
a feature like TT's [% META %] to set processing control directives in the
source files? Since DocSet uses TT would be handy if there was some meta
syntax for setting template vars.

Bill Moseley
mailto:moseley [at] hank

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

moseley at hank

Feb 7, 2002, 8:04 AM

Post #7 of 11 (791 views)
Permalink

Re: the search is working now [In reply to]

At 03:23 PM 2/7/2002 +0800, Stas Bekman wrote:

>>>>Should the search box, pdf/src and navigation be above the big title bar???
>>>> Seems like those things are more global in nature (in that they are on
>>>>most pages) but the title is for that specific page. Just looks a bit odd

For another example:

http://aspn.activestate.com/ASPN/Reference/Products/ActivePerl/lib/Pod/perlipc.html

Keeps the content more together, I think. (I don't think that page is fantastic, but it does show the title with the content and the nav above, that's all.)

Bill Moseley
mailto:moseley [at] hank

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

stas at stason

Feb 21, 2002, 3:22 AM

Post #8 of 11 (790 views)
Permalink

Re: the search is working now [In reply to]

Bill Moseley wrote:
> At 03:23 PM 2/7/2002 +0800, Stas Bekman wrote:
>
>>Bill Moseley wrote:
>>
>
>>>>Yeah, I thought about this. I'm not sure how to tell the template to do
>>>>a different thing. What's the rule? Ideas? Must be some config argument.
>>>>
>>>>
>>>Easy. Add to search/search.tt
>>>
>
> Ah, that's right. That's one reason why I was suggesting that the final
> site is built with ttree instead of DocSet. ;)
>
> searchresults.tmpl is built when DocSet is running. Maybe DocSet could use
> a feature like TT's [% META %] to set processing control directives in the
> source files? Since DocSet uses TT would be handy if there was some meta
> syntax for setting template vars.

That will require processing of the bodies, which may include TT directives
in code examples which will ruin them. Currently the converted sources
aren't
processed by TT, but included as is.

It'd be a mistake to make the source document depend on the DocSet
implementation.
The doc writers should only escape POD sequences, not things like TT
directives
in examples.
Any other ideas?

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

stas at stason

Feb 21, 2002, 3:25 AM

Post #9 of 11 (796 views)
Permalink

Re: the search is working now [In reply to]

Bill Moseley wrote:
> At 03:23 PM 2/7/2002 +0800, Stas Bekman wrote:
>
>
>>>>>Should the search box, pdf/src and navigation be above the big title bar???
>>>>>Seems like those things are more global in nature (in that they are on
>>>>>most pages) but the title is for that specific page. Just looks a bit odd
>>>>>
>
> For another example:
>
> http://aspn.activestate.com/ASPN/Reference/Products/ActivePerl/lib/Pod/perlipc.html
>
> Keeps the content more together, I think. (I don't think that page is fantastic, but it does show the title with the content and the nav above, that's all.)

the colourmap is horrible... we cannot put the breadcrumb together with
navigation since it won't fit in one line.

Now that I've integrated Allan's work, I'll play with it to try to make
it look nicer. I'll keep you updated.

--

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

moseley at hank

Feb 21, 2002, 6:53 AM

Post #10 of 11 (792 views)
Permalink

Re: the search is working now [In reply to]

At 06:22 PM 2/21/2002 +0800, Stas Bekman wrote:

>> searchresults.tmpl is built when DocSet is running. Maybe DocSet could use
>> a feature like TT's [% META %] to set processing control directives in the
>> source files? Since DocSet uses TT would be handy if there was some meta
>> syntax for setting template vars.
>

>Any other ideas?

Hum, well the idea is to set a TT variable, right? Maybe do an INCLUDE of
a TT file for each file, if found. Or maybe look for a file $file.ttinit
when processing each file. That could be a perl structure that's merged
with the TT params before calling process().

Or maybe just a map in the config file that adds variables to matching
pages.

Bill Moseley
mailto:moseley [at] hank

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

stas at stason

Feb 21, 2002, 8:05 AM

Post #11 of 11 (788 views)
Permalink

Re: the search is working now [In reply to]

Bill Moseley wrote:
> At 06:22 PM 2/21/2002 +0800, Stas Bekman wrote:
>
>
>>>searchresults.tmpl is built when DocSet is running. Maybe DocSet could use
>>>a feature like TT's [% META %] to set processing control directives in the
>>>source files? Since DocSet uses TT would be handy if there was some meta
>>>syntax for setting template vars.
>>>
>
>>Any other ideas?
>>
>
> Hum, well the idea is to set a TT variable, right? Maybe do an INCLUDE of
> a TT file for each file, if found. Or maybe look for a file $file.ttinit
> when processing each file. That could be a perl structure that's merged
> with the TT params before calling process().

Sounds like a good idea. I'm thinking whether it's better to have
$file.tt with real TT directives, or a perl structure to merge with vars
passed to process(). The latter is easy, is it possible to run some TT
template and then call process() so that, that template will affect the
run of process()? I've never tried that before. But wait

> Or maybe just a map in the config file that adds variables to matching
> pages.
I guess if in the future other template toolkits will be used with
DocSet it's better not to rely on TT syntax, but to set the control
variables in perl space.

While having an extra file is the easiest solution it is a pain to maintain.

So I guess coming up with a nice syntax for forwarding extra variables
from config file is the best portable solution. Something like:

extra => {
'search.html' => { nosearch => 1},
}

what do you think?

_____________________________________________________________________
Stas Bekman JAm_pH -- Just Another mod_perl Hacker
http://stason.org/ mod_perl Guide http://perl.apache.org/guide
mailto:stas [at] stason http://ticketmaster.com http://apacheweek.com
http://singlesheaven.com http://perl.apache.org http://perlmonth.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-dev-unsubscribe [at] perl
For additional commands, e-mail: docs-dev-help [at] perl

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads