You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In #8168, a link (db-dao.md#database-schema) has been modified as (db-dao.md#working-with-database-schema-). IMO, it should be reverted, since the intended anchor name in db-dao.md is 'database-schema'.
But it seems that the modification has been made based on the fact that the anchors are not rendered as intended in the github pages.
<h2>
<a id="user-content-working-with-database-schema-"
class="anchor"
href="#working-with-database-schema-"
aria-hidden="true">
<span class="octicon octicon-link"></span>
</a>
Working with Database Schema
</h2>
<p>Yii DAO provides ...
(Note that I've reformatted the htmls for the sake of readability)
As you see, <span id="database-schema"></span> is lost in the github version. And the auto created elements are different from each other.
As far as I understand, the policy in the Yii documentation is to use <span id="anchor-name"></span> for an anchor. And I do favor it, because it is easy to refer to from other places of the documentation.
It will be very hard for us to use and maintain such an anchor in the documentation source text.
Although the fact is that the anchors in the span tags are not rendered as intended in the github pages, and I think that we have to deal with the following problems:
In the github pages, the anchors won't work. This is inconvenient even if you are using them just for previewing purpose.
In the Yii site, we don't have the documentations of apps and extensions yet. As for now, the links to them from the Yii 2 guide can do nothing but point to the github pages.
The text was updated successfully, but these errors were encountered:
In #8168, a link
(db-dao.md#database-schema)
has been modified as(db-dao.md#working-with-database-schema-)
. IMO, it should be reverted, since the intended anchor name in db-dao.md is 'database-schema'.But it seems that the modification has been made based on the fact that the anchors are not rendered as intended in the github pages.
For example, this is what we have in http://www.yiiframework.com/doc-2.0/guide-db-dao.html
But the counterpart of it in https://github.com/yiisoft/yii2/blob/master/docs/guide/db-dao.md is:
(Note that I've reformatted the htmls for the sake of readability)
As you see,
<span id="database-schema"></span>
is lost in the github version. And the auto created elements are different from each other.As far as I understand, the policy in the Yii documentation is to use
<span id="anchor-name"></span>
for an anchor. And I do favor it, because it is easy to refer to from other places of the documentation.Especially, the auto created anchors based on the heading's text could be a nightmare for multi-byte languages: they will be URL-encoded. For example, https://github.com/yiisoft/yii2/blob/master/docs/guide-ja/db-dao.md goes like the following:
It will be very hard for us to use and maintain such an anchor in the documentation source text.
Although the fact is that the anchors in the
span
tags are not rendered as intended in the github pages, and I think that we have to deal with the following problems:The text was updated successfully, but these errors were encountered: