Module:Numlinks: Difference between revisions

← Older edit Newer edit →

@@ Line 84: / Line 84: @@
 end
--- Main function
+-- Arguments:
+-- - Is ordinal: should the values be cardinal numbers (eg, 12edo) or ordinal
+--   numbers (eg, 12th-octave)?
+-- - Page text: Text is formatted as [pre-text][n][post-text], stored in a table
+--   { pre } or { pre, post }. If the link config is for 8 links, then text is
+--   formatted as [pre-text][n1][mid-text][n2][post-text], stored in a table
+--   { mid, post } or { pre, mid, post }. Pre-text can be omitted since most
+--   pages don't have pre-text (12edo, 5L 2s).
+-- - Link text: Same as page text, except this changes the text of the link. If
+--   this is not specified, then the page and link text are the same.
+-- - Min: The smallest allowed value for a numbered link. Default is 1. There
+--   isn't a maximum since these numbers are assumed to be either natural or
+--   whole numbers.
 function p._numlinks(frame)
 	local args = getArgs(frame)