ReSpec changes for definitions

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

ReSpec changes for definitions

Shane McCarron
Hi all!

If you are using the <dfn> and <a> features of ReSpec to handle linking to your definitions, you will notice that there is a new warning related to this.  We have deprecated support for @title on definitions and <a> attributes.  This is to more closely align with Bikeshed (another publication tool) and to make @title available for use with A11Y or other features.

At the same time, we have added a feature where you can define aliases for your terms using the 'lt' attribute.  You can do aliases with a form like:

<dfn lt="term|terms|my term|another name">My Term</dfn>

You can reference this using <a>terms</a> (or any of its defined forms).  You can also reference it using <a lt="term">some string that is not an alias</a> if you like.

You will get warnings about your use of @title for a while.  At some point we pla on removing support for @title altogether.

Let me know if you have any questions.

--
Shane McCarron
Managing Director, Applied Testing and Technology, Inc.
Reply | Threaded
Open this post in threaded view
|

Re: ReSpec changes for definitions

Shane McCarron
Actually, after some discussion the community would prefer that the new attribute be 'data-lt' so that respec input will continue to validate.  I have pushed a new version that implements this change.

On Wed, Jul 29, 2015 at 3:44 PM, Shane McCarron <[hidden email]> wrote:
Hi all!

If you are using the <dfn> and <a> features of ReSpec to handle linking to your definitions, you will notice that there is a new warning related to this.  We have deprecated support for @title on definitions and <a> attributes.  This is to more closely align with Bikeshed (another publication tool) and to make @title available for use with A11Y or other features.

At the same time, we have added a feature where you can define aliases for your terms using the 'lt' attribute.  You can do aliases with a form like:

<dfn lt="term|terms|my term|another name">My Term</dfn>

You can reference this using <a>terms</a> (or any of its defined forms).  You can also reference it using <a lt="term">some string that is not an alias</a> if you like.

You will get warnings about your use of @title for a while.  At some point we pla on removing support for @title altogether.

Let me know if you have any questions.

--
Shane McCarron
Managing Director, Applied Testing and Technology, Inc.



--
Shane McCarron
Managing Director, Applied Testing and Technology, Inc.