I'd like to get thinking on how to present register behavior in the new Wiki, since I think it's going to take some experimentation. I think it's the biggest concrete style issue. Doing a good job can make a big difference on the overall Wiki. Some requirements:
* Clearly document what individual bits of a register do.
* Relatively easy to write.
* Vertically compact.
Take something like the APU noise channel, register $400E. The essential information present there is
$400E
Write-only
Controls loop and period
Bits 0-3 set period based on table [table here]
Bits 4-6 do nothing
Bit 7 is loop flag
Ideally we could let the Wiki convert this into a tabular form, so that we can easily change the way register behaviors are displayed, without having to edit every page. But this is probably not practical, or would involve some overly-complex solution.
The style in the linked APU noise page above works, but I'm not completely satisfied with it. I don't like the style as used on things like the MMC3 page, partly because it's more difficult to write. It's also less pleasant to read, as the text tends to run together. I definitely think the register descriptions need to be in a table, allowing styles, links, etc.
The style I developed for the APU on the old Wiki has the first line summarize the register, then the following ones elaborate. This allows a summary of multiple registers to just show the first line for each, with a link to show the full description.
* Clearly document what individual bits of a register do.
* Relatively easy to write.
* Vertically compact.
Take something like the APU noise channel, register $400E. The essential information present there is
$400E
Write-only
Controls loop and period
Bits 0-3 set period based on table [table here]
Bits 4-6 do nothing
Bit 7 is loop flag
Ideally we could let the Wiki convert this into a tabular form, so that we can easily change the way register behaviors are displayed, without having to edit every page. But this is probably not practical, or would involve some overly-complex solution.
The style in the linked APU noise page above works, but I'm not completely satisfied with it. I don't like the style as used on things like the MMC3 page, partly because it's more difficult to write. It's also less pleasant to read, as the text tends to run together. I definitely think the register descriptions need to be in a table, allowing styles, links, etc.
The style I developed for the APU on the old Wiki has the first line summarize the register, then the following ones elaborate. This allows a summary of multiple registers to just show the first line for each, with a link to show the full description.