You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficserver.apache.org by "Miles Libbey (JIRA)" <ji...@apache.org> on 2011/06/08 01:44:59 UTC
[jira] [Created] (TS-831) dd elements need to be on line to avoid p
elements
dd elements need to be on line to avoid p elements
--------------------------------------------------
Key: TS-831
URL: https://issues.apache.org/jira/browse/TS-831
Project: Traffic Server
Issue Type: Bug
Components: Documentation
Affects Versions: Doc 3.0
Reporter: Miles Libbey
Assignee: Igor Galić
In looking at the styling for
http://trafficserver.staging.apache.org/docs/trunk/admin/configuration-files/records.config
there are several dd elements that get P elements around the text, for no apparent reason.
For instance,
*`proxy.config.watch_script`* {#proxy.config.watch_script}
: `STRING`
: Default: `traffic_cop`
: The name of the executable that runs the `traffic_cop` process.
does not get a p element (as expected):
<dt id="proxy.config.watch_script"><em><code>proxy.config.watch_script</code></em></dt>
<dd><code>STRING</code></dd>
<dd>Default: <code>traffic_cop</code></dd>
<dd>The name of the executable that runs the <code>traffic_cop</code> process.</dd>
but
*`proxy.config.admin.number_config_bak`* {#proxy.config.admin.number_config_bak}
: `INT`
: Default: `3`
: The maximum number of copies of rolled configuration files to
keep.
does:
<dt id="proxy.config.admin.number_config_bak"><em><code>proxy.config.admin.number_config_bak</code></em></dt>
<dd>
<p><code>INT</code></p>
</dd>
<dd>
<p>Default: <code>3</code></p>
</dd>
<dd>
<p>The maximum number of copies of rolled configuration files to
keep.</p>
</dd>
Hypothesis is that if the last line:
: The maximum number of copies of rolled configuration files to
keep.
was instead on 1 line
: The maximum number of copies of rolled configuration files to keep.
there would not be a P elements.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (TS-831) dd elements need to be on line to avoid
p elements
Posted by "Igor Galić (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/TS-831?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13051898#comment-13051898 ]
Igor Galić commented on TS-831:
-------------------------------
I can monkey through the docs and change all the occurrences - but for some this won't be possible: What do we do when the description doesn't fit in one line? When it's multiple paragraphs long containing code examples etc..?
n.b.: The choice of Definition lists was a gut decision - if we find a better way to represent things, we should not not hesitate to change it.
> dd elements need to be on line to avoid p elements
> --------------------------------------------------
>
> Key: TS-831
> URL: https://issues.apache.org/jira/browse/TS-831
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
> Affects Versions: Doc 3.0
> Reporter: Miles Libbey
> Assignee: Igor Galić
>
> In looking at the styling for
> http://trafficserver.staging.apache.org/docs/trunk/admin/configuration-files/records.config
> there are several dd elements that get P elements around the text, for no apparent reason.
> For instance,
> *`proxy.config.watch_script`* {#proxy.config.watch_script}
> : `STRING`
> : Default: `traffic_cop`
> : The name of the executable that runs the `traffic_cop` process.
> does not get a p element (as expected):
> <dt id="proxy.config.watch_script"><em><code>proxy.config.watch_script</code></em></dt>
> <dd><code>STRING</code></dd>
> <dd>Default: <code>traffic_cop</code></dd>
> <dd>The name of the executable that runs the <code>traffic_cop</code> process.</dd>
> but
> *`proxy.config.admin.number_config_bak`* {#proxy.config.admin.number_config_bak}
> : `INT`
> : Default: `3`
> : The maximum number of copies of rolled configuration files to
> keep.
> does:
> <dt id="proxy.config.admin.number_config_bak"><em><code>proxy.config.admin.number_config_bak</code></em></dt>
> <dd>
> <p><code>INT</code></p>
> </dd>
> <dd>
> <p>Default: <code>3</code></p>
> </dd>
> <dd>
> <p>The maximum number of copies of rolled configuration files to
> keep.</p>
> </dd>
> Hypothesis is that if the last line:
> : The maximum number of copies of rolled configuration files to
> keep.
> was instead on 1 line
> : The maximum number of copies of rolled configuration files to keep.
> there would not be a P elements.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Resolved] (TS-831) dd elements need to be on line to avoid
p elements
Posted by "Igor Galić (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/TS-831?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Igor Galić resolved TS-831.
---------------------------
Resolution: Fixed
I fixed this on CSS level.
> dd elements need to be on line to avoid p elements
> --------------------------------------------------
>
> Key: TS-831
> URL: https://issues.apache.org/jira/browse/TS-831
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
> Affects Versions: Doc 3.0
> Reporter: Miles Libbey
> Assignee: Igor Galić
>
> In looking at the styling for
> http://trafficserver.staging.apache.org/docs/trunk/admin/configuration-files/records.config
> there are several dd elements that get P elements around the text, for no apparent reason.
> For instance,
> *`proxy.config.watch_script`* {#proxy.config.watch_script}
> : `STRING`
> : Default: `traffic_cop`
> : The name of the executable that runs the `traffic_cop` process.
> does not get a p element (as expected):
> <dt id="proxy.config.watch_script"><em><code>proxy.config.watch_script</code></em></dt>
> <dd><code>STRING</code></dd>
> <dd>Default: <code>traffic_cop</code></dd>
> <dd>The name of the executable that runs the <code>traffic_cop</code> process.</dd>
> but
> *`proxy.config.admin.number_config_bak`* {#proxy.config.admin.number_config_bak}
> : `INT`
> : Default: `3`
> : The maximum number of copies of rolled configuration files to
> keep.
> does:
> <dt id="proxy.config.admin.number_config_bak"><em><code>proxy.config.admin.number_config_bak</code></em></dt>
> <dd>
> <p><code>INT</code></p>
> </dd>
> <dd>
> <p>Default: <code>3</code></p>
> </dd>
> <dd>
> <p>The maximum number of copies of rolled configuration files to
> keep.</p>
> </dd>
> Hypothesis is that if the last line:
> : The maximum number of copies of rolled configuration files to
> keep.
> was instead on 1 line
> : The maximum number of copies of rolled configuration files to keep.
> there would not be a P elements.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira