Extensions Docs Server: Show properties of properties in the table of contents

Extensions Docs Server: Show properties of properties in the table of contents

Properties of properties were not being shown in the table of contents.

BUG=151866
Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=160302

[not at google - send to devlin, 2012-09-28 04:03:10]

sorry, can of worms!

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/api_property.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:2: <a
name="property-{{name}}"></a>
move name onto id of the property

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:13: <a
name={{property.name}}-properties></a>
I think this should actually be a <h4 id="...">Properties of {{name}}</h4>, it
looks much neater.

Or even

<h4 id="...">Properties of <a href="#property-{{name}}">{{name}}</a></h4>

(btw don't forget to put quotations around the attribute)

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:15:
{{+partials.parameter_full prefix:property.name property:true}}
"is_property" would be less confusing

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:19: <a
name={{property.name}}-functions></a>
ditto

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/api_reference.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_reference.html:13:
{{+partials.api_property api:api property:@}}
why do you need this change?

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/parameter_full.html
(right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/parameter_full.html:2:
{{?prefix}}<a
name="{{?property}}property{{:}}type{{/}}-{{prefix}}-{{name}}"></a>{{/}}
blarg, it would be nicer if this link were in the form of an id on the property
(as in, property.html have <span class="..." id="{{id}}">

however, that involves generating this "id" thing in the server.

That... would be really neat. It would clean up all these "prefix" shenanigans:

 > git grep prefix

api_property.html:      {{+partials.parameter_full prefix:property.name
property:true}}
event.html:  <a name="event-{{?prefix}}{{prefix}}-{{/}}{{name}}"></a>
event.html:    <span
class="subdued">{{?prefix}}{{prefix}}{{:}}chrome.{{api.name}}{{/}}.</span>{{name}}<span
class="subdued">.addListener</span>(function({{#parameters}}{{+partia
function.html:  <a name="method-{{?prefix}}{{prefix}}-{{/}}{{name}}"></a>
function.html:    <span>{{?returns}}{{+partials.variable_type}}
{{/}}{{?prefix}}{{prefix}}{{:}}chrome.{{api.name}}{{/}}.{{name}}</span>({{#parameters}}{{+partials.parameter_item}
parameter_full.html:  {{?prefix}}<a
name="{{?property}}property{{:}}type{{/}}-{{prefix}}-{{name}}"></a>{{/}}
toc_events.html:<a href="#{{?prefix}}{{prefix}}-{{/}}events">Events</a>
toc_events.html:  <li><a
href="#event-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a></li>
toc_functions.html:<a href="#{{?prefix}}{{prefix}}-{{/}}methods">Methods</a>
toc_functions.html:  <li><a
href="#method-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a></li>
toc_properties.html:<a
href="#{{?prefix}}{{prefix}}-{{/}}properties">Properties</a>
toc_properties.html:    <a
href="#property-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a>
toc_properties.html:    {{?functions}}<ol><li>{{+partials.toc_functions
prefix:name}}</li></ol>{{/}}
toc_properties.html:    {{?events}}<ol><li>{{+partials.toc_events
prefix:name}}</li></ol>{{/}}
toc_properties.html:    {{?properties}}<ol><li>{{+partials.toc_properties
prefix:name}}</li></ol>{{/}}
toc_types.html:<a href="#{{?prefix}}{{prefix}}-{{/}}types">Types</a>
toc_types.html:    <a
href="#type-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a>
toc_types.html:    {{?functions}}<ol><li>{{+partials.toc_functions
prefix:name}}</li></ol>{{/}}
toc_types.html:    {{?events}}<ol><li>{{+partials.toc_events
prefix:name}}</li></ol>{{/}}
type.html:      {{+partials.parameter_full prefix:type.name}}
type.html:      <dd><dl>{{#functions}}{{+partials.function api:api
prefix:type.name}}{{/}}</dl></dd>
type.html:      <dd><dl>{{#events}}{{+partials.event api:api
prefix:type.name}}{{/}}</dl></dd>


However, it would require a change to the server, and then we'd need to
coordinate pushing this change with updating the server. Not a big deal, we just
need to submit it in 2 separate changes.

But at least that change would be testable, though. What do you think?

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/parameter_full.html:4:
{{?properties}}
also, 80 chars if possible

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/toc_properties.html
(right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/toc_properties.html:8:
{{?properties}}<ol><li>{{+partials.toc_properties prefix:name}}</li></ol>{{/}}
80 chars if possible

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/type.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:3: <h4>{{name}}</h4>
move name onto id of the h4

and make the h4 a h3. Looks weird having the headers below be bigger than this.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:10: <a
name={{type.name}}-properties></a>
Can you make this <h3 id=...>Properties of {{type.name}}</h3>

or better, Properties of <a href="#type-{{name}}">type</a>

ditto other places

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:16: <a
name={{type.name}}-methods></a>
Can you move this link into the id of the h3 below?

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:21: <a
name={{type.name}}-events></a>
Ditto

[cduvall, 2012-09-29 00:37:49]

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/api_property.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:2: <a
name="property-{{name}}"></a>
On 2012/09/28 04:03:11, kalman wrote:
> move name onto id of the property

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:13: <a
name={{property.name}}-properties></a>
On 2012/09/28 04:03:11, kalman wrote:
> I think this should actually be a <h4 id="...">Properties of {{name}}</h4>, it
> looks much neater.
> 
> Or even
> 
> <h4 id="...">Properties of <a href="#property-{{name}}">{{name}}</a></h4>
> 
> (btw don't forget to put quotations around the attribute)

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:15:
{{+partials.parameter_full prefix:property.name property:true}}
On 2012/09/28 04:03:11, kalman wrote:
> "is_property" would be less confusing

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_property.html:19: <a
name={{property.name}}-functions></a>
On 2012/09/28 04:03:11, kalman wrote:
> ditto

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/api_reference.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/api_reference.html:13:
{{+partials.api_property api:api property:@}}
On 2012/09/28 04:03:11, kalman wrote:
> why do you need this change?

The api_property partial needs to refer to the property name from inside
{{?...}} or {{#...}} blocks which overwrite {{name}}. With this I can use
{{property.name}}.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/parameter_full.html
(right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/parameter_full.html:2:
{{?prefix}}<a
name="{{?property}}property{{:}}type{{/}}-{{prefix}}-{{name}}"></a>{{/}}
On 2012/09/28 04:03:11, kalman wrote:
> blarg, it would be nicer if this link were in the form of an id on the
property
> (as in, property.html have <span class="..." id="{{id}}">
> 
> however, that involves generating this "id" thing in the server.
> 
> That... would be really neat. It would clean up all these "prefix"
shenanigans:
> 
>  > git grep prefix
> 
> api_property.html:      {{+partials.parameter_full prefix:property.name
> property:true}}
> event.html:  <a name="event-{{?prefix}}{{prefix}}-{{/}}{{name}}"></a>
> event.html:    <span
>
class="subdued">{{?prefix}}{{prefix}}{{:}}chrome.{{api.name}}{{/}}.</span>{{name}}<span
> class="subdued">.addListener</span>(function({{#parameters}}{{+partia
> function.html:  <a name="method-{{?prefix}}{{prefix}}-{{/}}{{name}}"></a>
> function.html:    <span>{{?returns}}{{+partials.variable_type}}
>
{{/}}{{?prefix}}{{prefix}}{{:}}chrome.{{api.name}}{{/}}.{{name}}</span>({{#parameters}}{{+partials.parameter_item}
> parameter_full.html:  {{?prefix}}<a
> name="{{?property}}property{{:}}type{{/}}-{{prefix}}-{{name}}"></a>{{/}}
> toc_events.html:<a href="#{{?prefix}}{{prefix}}-{{/}}events">Events</a>
> toc_events.html:  <li><a
> href="#event-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a></li>
> toc_functions.html:<a href="#{{?prefix}}{{prefix}}-{{/}}methods">Methods</a>
> toc_functions.html:  <li><a
> href="#method-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a></li>
> toc_properties.html:<a
> href="#{{?prefix}}{{prefix}}-{{/}}properties">Properties</a>
> toc_properties.html:    <a
> href="#property-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a>
> toc_properties.html:    {{?functions}}<ol><li>{{+partials.toc_functions
> prefix:name}}</li></ol>{{/}}
> toc_properties.html:    {{?events}}<ol><li>{{+partials.toc_events
> prefix:name}}</li></ol>{{/}}
> toc_properties.html:    {{?properties}}<ol><li>{{+partials.toc_properties
> prefix:name}}</li></ol>{{/}}
> toc_types.html:<a href="#{{?prefix}}{{prefix}}-{{/}}types">Types</a>
> toc_types.html:    <a
> href="#type-{{?prefix}}{{prefix}}-{{/}}{{name}}">{{name}}</a>
> toc_types.html:    {{?functions}}<ol><li>{{+partials.toc_functions
> prefix:name}}</li></ol>{{/}}
> toc_types.html:    {{?events}}<ol><li>{{+partials.toc_events
> prefix:name}}</li></ol>{{/}}
> type.html:      {{+partials.parameter_full prefix:type.name}}
> type.html:      <dd><dl>{{#functions}}{{+partials.function api:api
> prefix:type.name}}{{/}}</dl></dd>
> type.html:      <dd><dl>{{#events}}{{+partials.event api:api
> prefix:type.name}}{{/}}</dl></dd>
> 
> 
> However, it would require a change to the server, and then we'd need to
> coordinate pushing this change with updating the server. Not a big deal, we
just
> need to submit it in 2 separate changes.
> 
> But at least that change would be testable, though. What do you think?

I think this would be awesome. I'm going to upload a separate patch for the
server changes that this patch will depend on. The server changes are here:
https://codereview.chromium.org/11018003/

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/parameter_full.html:4:
{{?properties}}
On 2012/09/28 04:03:11, kalman wrote:
> also, 80 chars if possible

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/toc_properties.html
(right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/toc_properties.html:8:
{{?properties}}<ol><li>{{+partials.toc_properties prefix:name}}</li></ol>{{/}}
On 2012/09/28 04:03:11, kalman wrote:
> 80 chars if possible

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
File chrome/common/extensions/docs/templates/private/type.html (right):

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:3: <h4>{{name}}</h4>
On 2012/09/28 04:03:11, kalman wrote:
> move name onto id of the h4
> 
> and make the h4 a h3. Looks weird having the headers below be bigger than
this.

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:10: <a
name={{type.name}}-properties></a>
On 2012/09/28 04:03:11, kalman wrote:
> Can you make this <h3 id=...>Properties of {{type.name}}</h3>
> 
> or better, Properties of <a href="#type-{{name}}">type</a>
> 
> ditto other places

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:16: <a
name={{type.name}}-methods></a>
On 2012/09/28 04:03:11, kalman wrote:
> Can you move this link into the id of the h3 below?

Done.

https://codereview.chromium.org/10985071/diff/1/chrome/common/extensions/docs...
chrome/common/extensions/docs/templates/private/type.html:21: <a
name={{type.name}}-events></a>
On 2012/09/28 04:03:11, kalman wrote:
> Ditto

Done.

[not at google - send to devlin, 2012-10-03 01:17:11]

lgtm but don't submit until we get all the server changes in obviously.

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/parameter_full.html
(right):

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/parameter_full.html:2:
{{?parent}}<a id="{{id}}"></a>{{/}}
this should be name= for a's right?

or you could put the id on the surrounding div.

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/type.html (right):

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/type.html:29: {{+partials.event
api:api}}{{/}}
nice: 1 level less indentation?

[cduvall, 2012-10-05 01:16:15]

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/parameter_full.html
(right):

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/parameter_full.html:2:
{{?parent}}<a id="{{id}}"></a>{{/}}
On 2012/10/03 01:17:11, kalman wrote:
> this should be name= for a's right?
> 
> or you could put the id on the surrounding div.

Done.

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
File chrome/common/extensions/docs/templates/private/type.html (right):

http://codereview.chromium.org/10985071/diff/10001/chrome/common/extensions/d...
chrome/common/extensions/docs/templates/private/type.html:29: {{+partials.event
api:api}}{{/}}
On 2012/10/03 01:17:11, kalman wrote:
> nice: 1 level less indentation?

Done.