Module:ProfessionList/doc

This is a documentation subpage for Module:ProfessionList. It contains usage information, categories, and other content that is not part of the original module page.

Module:ProfessionList requires Module:Currency.

Module:ProfessionList requires Module:RecipeTreeSearch.

Module:ProfessionList is required by 10 modules

1. Module:FisherList
2. Module:FisherPassiveList
3. Module:ForagerList
4. Module:ForagerPassiveList
5. Module:GathererList
6. Module:GathererPassiveList
7. Module:MinerList
8. Module:MinerPassiveList
9. Module:WoodcutterList
10. Module:WoodcutterPassiveList

.

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See Brighter Shores:Lua/Helper modules for a full list and more information.

Function	Type	Use
currency_cell(amount)	amount: number, or nil	Returns the HTML to create a table currency cell using module:currency._cell. If instead it is supplied with nil then a 10x1 cell is created with the text "unknown". Use within :node()
unknown_value_cell(size)	size: integer	Returns the HTML to create a 'size'x1 cell with the text "unknown". Use within :node()
unknown_value_edit_cell(page,size)	page: string name of page size: integer	Returns the HTML to create a 'size'x1 cell with a link to edit the specified page. Use within :node()
generate_recipe_table(queryString)	queryString: string	Generates a table of recipes and activities from a Semantic MediaWiki query string. The queryString is just a selection of pages, from any combination of SMW properties and categories. For pages with multiple recipes or activities, will make one entry into the results table for each. The results table entries are the recipe/activity JSONs, with pageName and pageImage parameters added. The results table is sorted by recipe/activity level, independent of profession.