View source for Template:rhymes/documentation

{{documentation subpage}}
{{uses lua|Module:rhymes}}
==Usage==

 * {{temp|rhymes|rad|adz}}

Generates:

* {{rhymes|rad|adz|nocat=1}}

and automatically adds the category [[:Category:Rhymes:Radestrian/adz|Rhymes:Radestrian/adz]] to the page. The number displays how many terms have this rhyme (if greater than 1).
<hr>
[[Template:IPA|All input in X-SAMPA gets converted to IPA]]. As with {{temp|IPA}}, the escape character is <code>#</code>.

 * {{temp|rhymes|rad|Es|nopre=1}}

Generates:

* {{rhymes|rad|Es|nocat=1|nopre=1}}
<hr>
Multiple rhymes are supported:

 * {{temp|rhymes|rad|a|ɤ}}

Generates:

* {{rhymes|rad|a|ɤ|nocat=1}}
<hr>
If the rhyme category is not an 'active rhyme' (the category does not have more than one entry), then the page is still categorised, but the rhyme will appear as text, rather than as a link to the rhyme page.

 * {{temp|rhymes|rad|anθvatsisk}}

Generates:

* {{rhymes|rad|anθvatsisk|nocat=1}}
<hr>
{{para|nopre}} will remove the rhyme text from the start.

 * {{temp|rhymes|rad|adz|nopre=1}}

Generates:

* {{rhymes|rad|adz|nocat=1|nopre=1}}
<hr>
{{para|nocat}} will suppress categorisation.

=== Stress functionality ===
The template will automatically remove non-syllabic elements.

 * {{temp|rhymes|rad|skradz}}

Generates:

* {{rhymes|rad|skradz|nocat=1}}
<hr>
If a primary stress mark is present, it will take the rhyme from the stress mark onwards.

 * {{temp|rhymes|rad|aˈɛʃtɛ}}

Generates:

* {{rhymes|rad|aˈɛʃtɛ|nocat=1}}
<hr>
If the language is registered '''[[Module:rhymes|in the code]]''' as taking rhyme from secondary stress, this will be accounted for. If the language is also registered to ignore the primary stress if secondary stress is present, this will also be accounted for. Radestrian does not use secondary stress, but Laefevian does.

 * {{temp|rhymes|rad|{{rad-IPA|cĵátúl-age}}}}
 * {{temp|rhymes|lfv|ˈaŋɡiˌliɬu̯ɔdens}}

Generates:

* {{rhymes|rad|{{rad-IPA|cĵátúl-age}}|nocat=1}}
* {{rhymes|lfv|ˈaŋɡiˌliɬuɔdens|nocat=1}}