Talk:SDK Docs
Archives
Keyvalues or SmartEdit text?
How should the keyvalues for entities be described? The options are the following:
1. SmartEdit text only: the keyvalues are listed and described using the smartedit text only. Example: A possible value for the npc_citizen keyvalue "Ammo To Resupply" is "Crossbow Bolt".
2. Actual keyvalue: they keyvalues are listed and described using the actual keyvalues only. Example: A possible value for the npc_citizen keyvalue "AmmoSupply" is "XBowBolt".
3. Both SmartEdit text and actual keyvalues: the keyvalues are listed and described using both systems. Example: A possible value for npc_citizen keyvalue "Ammo To Resupply (AmmoSupply)" is "Crossbow Bolt (XBowBolt)".
Previously, entries were generally a mixture of 1 and 3, with some keyvalues described using the smartedit text and then the "literal value" which was the actual keyvalue. These literal values are being removed as part of Tom's much-welcome cleanup of the entity entries. Using only 2 (the actual keyvalue) has led to some confusion, as in the recent back and forth edits of Env_hudhint.
Ideally, there would be a link on each page (view entry as SmartEdit text / view entry as Keyvalues) which would switch between the two. If this is too complicated, then perhaps we could have some other system which would describe the relationship between keyvalues and their SmartEdit counterparts? --Fitzroy doll 10:05, 20 July 2009 (UTC)
- Thanks for the support. I spent an unhealthy amount of time editing yesterday. ;-) My reasoning for removing the raw keyvalue names is that they are only ever seen when writing an FGD or DATADESC; the only other (and the most important) time KVs crop up is in Hammer dialogues, where SmartEdit gives them friendly names. Even if you turn SmartEdit off for some reason, you can always turn it back on again. --TomEdwards 10:14, 20 July 2009 (UTC)
- Okay fair enough. The raw keyvalues also come up in mods in which users can create edits to entity tables by hand, outside hammer (GMOD, SMOD, Obsidian Conflict, Synergy, etc.) or when viewing ent tables extracted from bsps for reference. But I suppose these are specialised circumstances, not directly related to the use of the SDK itself. Many existing entity entries will need a look with this new view in mind to make the policy consistent, and perhaps a notice should be placed in the Help:Contents section to inform future editors. --Fitzroy doll 10:36, 20 July 2009 (UTC)
Retiring Template:EP1 add
I think we can assume that everyone is at least using the Ep1 codebase now. Retiring the template is easy: we just replace its contents with {{{1}}}.
Anyone feel that it still serves a purpose? --TomEdwards 08:54, 20 July 2009 (UTC)
Note/Tip/Warning/Bug message wrap
See Template:Tip for my proposal. --TomEdwards 10:23, 20 July 2009 (UTC)
New SDK Docs layout
Draft is at User:TomEdwards/SDK Docs draft. This version:
- Reduces bumf before you reach the contents table to the essentials
- Removes table items that are subcategories of other items (e.g. AI and VGUI)
- Sorts categories by popularity (kind of)
- Shortens category descriptions
- Adds translation flags (they are misaligned because of the link back to my userpage)
- Uses a nicer logo
--TomEdwards 11:15, 20 July 2009 (UTC)