Difference between revisions of "Documentation Talk:Contents"

From POV-Wiki
Jump to navigation Jump to search
Line 23: Line 23:
  
 
::Check the [[Documentation:Contents/POV-Ray Reference/Introduction/Notation and Basic Assumptions|content]] page; at least for me it's displaying the colors (and I'm using a different system than I made the changes on). If you still don't see them, make sure the source for the page shows something like <code>@import "/content?title=MediaWiki:Common.css</code>. [[User:Chrisc|chrisc]] 01:49, 8 January 2008 (UTC)
 
::Check the [[Documentation:Contents/POV-Ray Reference/Introduction/Notation and Basic Assumptions|content]] page; at least for me it's displaying the colors (and I'm using a different system than I made the changes on). If you still don't see them, make sure the source for the page shows something like <code>@import "/content?title=MediaWiki:Common.css</code>. [[User:Chrisc|chrisc]] 01:49, 8 January 2008 (UTC)
 +
::One thing I've just noticed is that the wiki doesn't allow non-logged-in users to access common.css. Not sure why, but the net result is that folks reading the wiki without logging in won't get the enhanced CSS markup mentioned above. I'll have to fix this, once I've worked out why it's happening. [[User:Chrisc|chrisc]] 00:51, 9 January 2008 (UTC)

Revision as of 00:51, 9 January 2008

Planning needed

We need a list of the wiki page names that every documentation section will have. There are duplicate names, like in Tutorial: Isosurface Object, Reference: Isosurface Object, and Quick reference: Isosurface. What should the wiki pages for those be called?

Making them links also helps see which pages are missing.

Nicolas 19:21, 5 November 2007 (UTC)

I intend to import the official POV-Ray documentation into this namespace at some point; I didn't link to this part of the wiki from the navigation bar because it's not really ready for content. Once the docs are imported then folks will be free to offer changes and updates. Note that this will require that the docs in this portion of the wiki be licensed according to the existing POV license (and thus edits must also be).
If there is strong enough interest by folks willing to re-write the docs under a free license such as the Creative Commons ones, for example, then I'll split the doc area accordingly.
WikiSysop 21:24, 5 November 2007 (UTC)
Damn, I totally forgot about licensing issues. So, either existing docs get imported and we're stuck with the POV doc license, or they get rewritten to make them CC... That would need some discussion on the ng's.
Nicolas 21:40, 5 November 2007 (UTC)

Documentation Content

In the absence of movement in this area I have created the skeleton of (most of) the documentation as it is laid out in the official documentation. It won't be much longer before the skeleton is complete.
However, I have also started to add content and am asking the administrators to please add some classes to (one of) the wiki stylesheets for use in the documentation. So far I have used:

  • "keyword" for styling keywords
  • "syntax" for styling syntax items
  • "location" for styling paths.

Please feel free to create whatever classes you want according to your standards, I will use them as you specify. The above are just preliminary examples and can easily be changed. Also please set the properties as you see fit. I used properties that mimic the original documentation except in color, so as to differentiate between wiki links and documentation items. Again, these are just examples and can easily be changed.

Once you have created the classes, please document them in the Editing Guidelines so that people adding documentation will know how to format the content.

Note that I am rewording the content such that it falls under the license of this wiki but retains the original meaning.
Eddie 19:07, 6 January 2008 (UTC)

Thanks Chris. (You're fast!). I don't see any color, so I'm not sure if it is what you intended or if my browser has a caching issue. Since I cannot see the stylesheet to troubleshoot I will continue in the hopes that things appear as you want them to. Eddie 01:40, 8 January 2008 (UTC)
Check the content page; at least for me it's displaying the colors (and I'm using a different system than I made the changes on). If you still don't see them, make sure the source for the page shows something like @import "/content?title=MediaWiki:Common.css. chrisc 01:49, 8 January 2008 (UTC)
One thing I've just noticed is that the wiki doesn't allow non-logged-in users to access common.css. Not sure why, but the net result is that folks reading the wiki without logging in won't get the enhanced CSS markup mentioned above. I'll have to fix this, once I've worked out why it's happening. chrisc 00:51, 9 January 2008 (UTC)