Re: configuration guide link

2007-08-22 Thread Adrian Chadd
On Wed, Aug 22, 2007, Amos Jeffries wrote:

 I have been giving that some thought and there are a few major changes I'd
 put in place before any CSS prettiness
 
 1) add a SEE_ALSO: item to the cf.data.pre format
- many of the options apply to more than just one 'area'
  ie icp_port fits into networking options and ICAP options areas
 
 2) make a nice consistent way of titling the areas
 
 3) re-order all the areas based on dependancies and common-usage
- ie *_access depend on acl X
 
 I know thats a lot of change, but to be pretty it's needed.

Yup, but is there any particular reason why pretty-ifying the pages has
to block on tidying up/improving cf.data.pre?



Adrian



Re: configuration guide link

2007-08-22 Thread Amos Jeffries

Adrian Chadd wrote:

On Wed, Aug 22, 2007, Amos Jeffries wrote:


I have been giving that some thought and there are a few major changes I'd
put in place before any CSS prettiness

1) add a SEE_ALSO: item to the cf.data.pre format
   - many of the options apply to more than just one 'area'
 ie icp_port fits into networking options and ICAP options areas

2) make a nice consistent way of titling the areas

3) re-order all the areas based on dependancies and common-usage
   - ie *_access depend on acl X

I know thats a lot of change, but to be pretty it's needed.


Yup, but is there any particular reason why pretty-ifying the pages has
to block on tidying up/improving cf.data.pre?



Nothing blocking, just a wishlist really.

Amos


Re: configuration guide link

2007-08-22 Thread Amos Jeffries

Adrian Chadd wrote:

On Wed, Aug 22, 2007, Amos Jeffries wrote:


I have been giving that some thought and there are a few major changes I'd
put in place before any CSS prettiness

1) add a SEE_ALSO: item to the cf.data.pre format
   - many of the options apply to more than just one 'area'
 ie icp_port fits into networking options and ICAP options areas

2) make a nice consistent way of titling the areas

3) re-order all the areas based on dependancies and common-usage
   - ie *_access depend on acl X

I know thats a lot of change, but to be pretty it's needed.


Yup, but is there any particular reason why pretty-ifying the pages has
to block on tidying up/improving cf.data.pre?



Oh, (click!) were you asking me to do the pretty?

Amos


Re: configuration guide link

2007-08-22 Thread Adrian Chadd
On Wed, Aug 22, 2007, Amos Jeffries wrote:

 Nothing blocking, just a wishlist really.

Squid's wishlist is long; lets try to trim off whatever we can. :P

I agree they are good ideas - and I'd really like to see those section
markers be explicit section markers rather than comments which we
pre mark - but I think those pages are butt ugly and I didn't have any
intention of putting them anywhere very public until they were made
much prettier.

Maybe I'll just have to pretty them up myself and include it in my
squid appliance..



Adrian



Re: configuration guide link

2007-08-22 Thread Adrian Chadd
On Wed, Aug 22, 2007, Amos Jeffries wrote:

 Oh, (click!) were you asking me to do the pretty?

Only if you want. You seem to know CSS/HTML better than I.



Adrian



Re: configuration guide link

2007-08-22 Thread Amos Jeffries
 On Wed, Aug 22, 2007, Amos Jeffries wrote:

 Nothing blocking, just a wishlist really.

 Squid's wishlist is long; lets try to trim off whatever we can. :P

 I agree they are good ideas - and I'd really like to see those section
 markers be explicit section markers rather than comments which we
 pre mark - but I think those pages are butt ugly and I didn't have any
 intention of putting them anywhere very public until they were made
 much prettier.

 Maybe I'll just have to pretty them up myself and include it in my
 squid appliance..


I just did it.
The templates are now labeled with CSS hooks, and a new cfgman.css is
added to modify some default.css settings so they don't look bad.

Anything else will depend on getting rid of the pre

Amos




Re: configuration guide link

2007-08-22 Thread Adrian Chadd
On Thu, Aug 23, 2007, Amos Jeffries wrote:

 I just did it.
 The templates are now labeled with CSS hooks, and a new cfgman.css is
 added to modify some default.css settings so they don't look bad.
 
 Anything else will depend on getting rid of the pre

Which won't be that hard - create a section marker which generates
the same output used to delineate sections in the cf file today.
(Ie, uppercase and then a line of dashes.) That kills the most
horrible use of pre in cfgman.

The other use is comments but there's too much assumed layout there
for it to be a non-trivial task. I'll wait for your CSS modifications
to show up on the live site before I fiddle with the entry layouts.



Adrian



Re: configuration guide link

2007-08-22 Thread Amos Jeffries
 On Thu, Aug 23, 2007, Amos Jeffries wrote:

 I just did it.
 The templates are now labeled with CSS hooks, and a new cfgman.css is
 added to modify some default.css settings so they don't look bad.

 Anything else will depend on getting rid of the pre

 Which won't be that hard - create a section marker which generates
 the same output used to delineate sections in the cf file today.
 (Ie, uppercase and then a line of dashes.) That kills the most
 horrible use of pre in cfgman.

 The other use is comments but there's too much assumed layout there
 for it to be a non-trivial task. I'll wait for your CSS modifications
 to show up on the live site before I fiddle with the entry layouts.


Just while I was doing it I had a thought.
Correct me if I'm wrong on this but it seems the aliases for any option
are actually all the old deprecated names for it.
If thats right, the Also known As: section should become Replaces: as
we really want the deprecated names to die off.

Amos




Re: configuration guide link

2007-08-22 Thread Henrik Nordstrom
On tor, 2007-08-23 at 11:25 +1200, Amos Jeffries wrote:

 If thats right, the Also known As: section should become Replaces: as
 we really want the deprecated names to die off.

Yes.

Except in very few rare cases when an alias is added to an older release
to support configurations from a newer release. But those can be ignored
for now (don't think we have any such aliases in 2.6).

Regards
Henrik



Re: configuration guide link

2007-08-21 Thread Amos Jeffries
 Now that there's automatically generated guides from the source
 available (and they're not easy to find!), should the configuration
 guide link on http://www.squid-cache.org/ and elsewhere point to
 them?

 The visolve stuff is great, but it's not authoritative.

 Just a thought,


I good one though.
I have just split the Configuration Guide link in the menubar into three.
One for each of the official latest, and one for the old visolve page.
The visolve page is a year outdated now.

Amos



Re: configuration guide link

2007-08-21 Thread Adrian Chadd
On Wed, Aug 22, 2007, Amos Jeffries wrote:

 I good one though.
 I have just split the Configuration Guide link in the menubar into three.
 One for each of the official latest, and one for the old visolve page.
 The visolve page is a year outdated now.

Hm, lets make the page look pretty now ? :)





Adrian



Re: configuration guide link

2007-08-21 Thread Amos Jeffries
 On Wed, Aug 22, 2007, Amos Jeffries wrote:

 I good one though.
 I have just split the Configuration Guide link in the menubar into
 three.
 One for each of the official latest, and one for the old visolve page.
 The visolve page is a year outdated now.

 Hm, lets make the page look pretty now ? :)


I have been giving that some thought and there are a few major changes I'd
put in place before any CSS prettiness

1) add a SEE_ALSO: item to the cf.data.pre format
   - many of the options apply to more than just one 'area'
 ie icp_port fits into networking options and ICAP options areas

2) make a nice consistent way of titling the areas

3) re-order all the areas based on dependancies and common-usage
   - ie *_access depend on acl X

I know thats a lot of change, but to be pretty it's needed.

Amos