Module category guidelines

From iPodLinux

Jump to: navigation, search

Due to the great number of podzilla2 modules currently being worked on and added to the tree, the "Extras" submenu has developed a rather unkempt appearance. These guidelines have been instated to fix that. If you have a suggestion for an addition or change, ask josh or courtc. Don't just ignore these if you don't like them.

Overall Menu Guidelines

  • No module should create any new top-level menu items. The current top-level menu items are Music, Extras, Settings, File Browser, Power, and Now Playing.
  • Only music playing modules may mess with the Music and Now Playing top-level menu items. 'Nuff said.
  • No more than one menu item per module in the Settings menu. This is intended to reduce settings creep; users with a lot of modules will soon find unweildily large Settings menus if we don't do something about it now :-). If you have a bunch of settings, feel free to make a submenu for your module.
  • Only globally important settings should go in Settings. This mainly means one particular thing: if your module is a game, and it's only launched from one place (in Extras), put settings in that menu! It's just more logical.
  • Absolutely nothing in the Power menu. No exceptions.
  • Don't mess with File Browser unless you're writing one.

Extras Menu Guidelines

  • The Extras menu has three submenus: Demos, Games, and Utilities. You may not make other submenus in Extras. You may not put your module's menu items in Extras root unless you get special approval and get added to the list below.
  • In Demos go: graphics demos (Matrix, Cube, Noise), and any other cool-for-twenty-seconds things.
  • In Games go: the stuff whose primary purpose is to have fun. This shouldn't be too hard.
  • In Utilities: anything remotely useful. This includes PodDraw, PodWrite, Resistors, etc. When in doubt, pick Utilities over Demos if your module actually does anything useful.
  • In the Extras root: The following modules are authorized to be put in the Extras root. No other modules may be put there. We mean it.
    • Credits (once it exists)
    • Clock
    • Recording (once it exists)
NOTHING ELSE.

Any comments, please be constructive — tell us instead of just ignoring the rules you don't like :-)   Thanks! — Josh (talk) 02:31, 20 Jan 2006 (CST)

Retrieved from "http://ipodlinux.org/wiki/Module_category_guidelines"