User:OgreBot/gallery-config/doc

This subpage contains documentation, categories, or other content that is not part of the user.
To view the user page itself, see User:OgreBot/gallery-config.

---

A single configuration for User:OgreBot/gallery.

Usage

{{User:OgreBot/gallery-config
 |page =
 |category =
 |category depth =
 |category 2 =
 |category 2 depth =
 |omit =
 |omit 2 =
 |hard omit =
 |hard omit depth =
 |hard omit 2 =
 |hard omit 2 depth =
 |width =
 |height =
 |days per gallery =
 |mode =
 |warning =
 |show filename =
 |noindex =
 |subpage =
 |max overflow =
}}

Template parameters

Parameter	Description		Default	Status
page	string	The output page where the gallery will reside	empty	required
category	string	The first category that the bot should search	empty	required
category depth	integer	Add a maximum depth for the category above.	empty	optional
category 2	string	Add another category that the bot should search. Replace 2 with any unique integer value (2, 3, 10000, etc.)	empty	optional
category 2 depth	integer	Add a maximum depth for the category above. Replace 2 with any unique integer value (2, 3, 10000, etc.)	empty	optional
omit	string	The first category that the bot should ignore. A file can still be part of the category tree if it comes in through an alternate path that doesn't involve the present omission.	empty	optional
omit 2	string	Another category that the bot should ignore. Replace 2 with any unique integer value (2, 3, 10000, etc.)	empty	optional
hard omit	string	The first category that the bot should hard omit. The hard omit is much more powerful than a soft omit. The hard omit will always omit a file if it's in its tree; a soft simply ignores a category but can arrive through a different path. Use this sparingly.	empty	optional
hard omit depth	integer	Add a maximum depth for the hard omits. Defaults to 0, meaning it will only be omitted if the category is on the file itself. If you set to 1, then it would include parent categories, 2 for parent parent, etc. The higher you set this value, the more likely the gallery will omit files you want. As such, a low value is recommended here.	empty	optional
hard omit 2	string	Another category to hard omit. Replace 2 with any unique integer value (2, 3, 10000, etc.)	empty	optional
hard omit 2 depth	integer	Add a maximum depth for the omission above. Replace 2 with any unique integer value (2, 3, 10000, etc.)	empty	optional
width	integer	To specify a width.	empty	optional
height	integer	To specify a height.	empty	optional
days per gallery	integer 1-31	The maximum number of days in a single gallery page. This option will be ignored if the subpage is false. A value of 11 mean 3 galleries per month.	11	optional
mode	string	See mw:Help:Images#Mode parameter. If omitted, the bot will not add the mode parameter to the gallery.	empty	optional
warning	true/false	Affix the template User:OgreBot/gallery/notice to the top of each gallery. This is primarily for categories which might inadvertently cause offense or libel.	empty	optional
show filename	true/false	see mw:Help:Images#Gallery_syntax.	empty	optional
noindex	true/false	Affix the code __NOINDEX__ to the top of the gallery. See mw:Noindex.	empty	optional
subpage	true/false	Create subpages. This option left as default in most cases. Only choose this if you believe there will be no more than a few uploads in your category per month; otherwise, your gallery will become too big.	true	optional
max overflow	number	The maximum number of "overflow" pages. This should only be used for galleries which have a large number of direct uploads (e.g., Category:Pronunciation). Please consult with the bot maintainer before using this option.	3	optional

Additional information

The template is intended to be used in the following namespaces: the User namespace

The template is intended to be used by the following user groups: all users