Note: You are currently viewing documentation for Moodle 1.9. Up-to-date documentation for the latest stable version is available here: Guidelines for contributors.

MoodleDocs talk:Guidelines for contributors: Difference between revisions

From MoodleDocs
No edit summary
 
(→‎Reason for minor changes to page: why I made a few changes)
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
==Theme for screenshots==
Hi,
Hi,


The Demo site theme is currently set to Standard White not Standard as per the guidelines. It would probably be best to change this for a couple of reasons:
The Demo site theme is currently set to Standard White not Standard as per the guidelines. It would probably be best to change this for a couple of reasons:


The standard theme is ubiquitous
The standard theme is ubiquitous<br>
It uses the 1.5.+ etc. theme model
It uses the 1.5.+ etc. theme model


Ray
[[User:Ray|Ray]] 19:10, 29 January 2006 (WST)
 
:Hi Ray, thanks for your comment. I've edited [[Guidelines for Contributors]] to say "Please use the official Moodle demo site, or any other site or course using one of the standard themes." --[[User:Helen|Helen]] 05:47, 30 January 2006 (WST)
 
==Inter-language links==
 
I would suggest to add the expression: "in the bottom of the page" to specify the preferred place to set the inter-lang links. [[User:Eloy Lafuente (stronk7)|Eloy Lafuente (stronk7)]] 18:40, 18 February 2006 (WST)
 
:Thanks Eloy - done! --[[User:Helen Foster|Helen Foster]] 18:49, 18 February 2006 (WST)
 
== Guidelines for screenshots? ==
 
JPEGs are for photographic images, and they make smudgy screenshots. I'd like to see a preference for PNG screenshots. An obvious guideline is not to include real personal data (or sensitive server data) in the screenshots. --[[User:Samuli Karevaara|Samuli Karevaara]] 22:52, 6 September 2008 (CDT)
 
: Hmm... there was guidelines for the screenshots in the Style Guide. It's an early morning here :-) --[[User:Samuli Karevaara|Samuli Karevaara]] 22:54, 6 September 2008 (CDT)
 
:: Testing the timestamp. The server time says 03:55, and I have an offset of three hours. but my timestamp doesn't say 06:55. Too early for Mediawiki manual reading time for me. --[[User:Samuli Karevaara|Samuli Karevaara]] 22:58, 6 September 2008 (CDT)
 
:::Here is the link for the early readers in [[MoodleDocs:Style_guide#Screenshots]] :)  But MediaWiki help is probably more informative.  As far as writing suggestions in this link, I will let others do it. 
 
:::I have often wondered about the smudgy screen shots which I always thought happened with the image size did not match the display size.  I have never played with PNG files at different display resolutions.  Best --[[User:chris collman|chris collman]] 17:11, 10 September 2008 (CDT)
 
:::: I would suggest moving some of the content to [[Screenshots]] like with [[Screencasts]] to keep the main page slim. --[[User:Frank Ralf|Frank Ralf]] 11:12, 25 February 2009 (CST)
 
== Section for Advanced Documentation Features? ==
 
I would suggest a special section or page for advanced documentation features, e.g. using Special pages, guidelines for refactoring existing documentation, resources and tools for maintaining documentation, etc. --[[User:Frank Ralf|Frank Ralf]] 10:46, 25 February 2009 (CST)
 
==Reason for minor changes to page==
"Guidelines for contributors" is the title and in the content of this page, it says that the page is an example of a general page in MoodleDocs.  This seems true (maybe I wrote those words :) ).  It could be just me, but I think it is friendly for a new user to see a short (1 or 2 sentences) that give some context for the page, followed by the first heading.  I also like to see a "See also" when there are other pages to link to.  So thought, so fixed!
:I confess that the links I put in the See also already exist in the content area and in the template. I think there are better examples (maybe externally to MediaWiki help pages?) but for now, there is something.--[[User:chris collman|chris collman]] 19:13, 25 May 2009 (UTC)

Latest revision as of 19:13, 25 May 2009

Theme for screenshots

Hi,

The Demo site theme is currently set to Standard White not Standard as per the guidelines. It would probably be best to change this for a couple of reasons:

The standard theme is ubiquitous
It uses the 1.5.+ etc. theme model

Ray Lawrence 19:10, 29 January 2006 (WST)

Hi Ray, thanks for your comment. I've edited Guidelines for Contributors to say "Please use the official Moodle demo site, or any other site or course using one of the standard themes." --Helen Foster 05:47, 30 January 2006 (WST)

Inter-language links

I would suggest to add the expression: "in the bottom of the page" to specify the preferred place to set the inter-lang links. Eloy Lafuente (stronk7) 18:40, 18 February 2006 (WST)

Thanks Eloy - done! --Helen Foster 18:49, 18 February 2006 (WST)

Guidelines for screenshots?

JPEGs are for photographic images, and they make smudgy screenshots. I'd like to see a preference for PNG screenshots. An obvious guideline is not to include real personal data (or sensitive server data) in the screenshots. --Samuli Karevaara 22:52, 6 September 2008 (CDT)

Hmm... there was guidelines for the screenshots in the Style Guide. It's an early morning here :-) --Samuli Karevaara 22:54, 6 September 2008 (CDT)
Testing the timestamp. The server time says 03:55, and I have an offset of three hours. but my timestamp doesn't say 06:55. Too early for Mediawiki manual reading time for me. --Samuli Karevaara 22:58, 6 September 2008 (CDT)
Here is the link for the early readers in MoodleDocs:Style_guide#Screenshots :) But MediaWiki help is probably more informative. As far as writing suggestions in this link, I will let others do it.
I have often wondered about the smudgy screen shots which I always thought happened with the image size did not match the display size. I have never played with PNG files at different display resolutions. Best --Chris collman 17:11, 10 September 2008 (CDT)
I would suggest moving some of the content to Screenshots like with Screencasts to keep the main page slim. --Frank Ralf 11:12, 25 February 2009 (CST)

Section for Advanced Documentation Features?

I would suggest a special section or page for advanced documentation features, e.g. using Special pages, guidelines for refactoring existing documentation, resources and tools for maintaining documentation, etc. --Frank Ralf 10:46, 25 February 2009 (CST)

Reason for minor changes to page

"Guidelines for contributors" is the title and in the content of this page, it says that the page is an example of a general page in MoodleDocs. This seems true (maybe I wrote those words :) ). It could be just me, but I think it is friendly for a new user to see a short (1 or 2 sentences) that give some context for the page, followed by the first heading. I also like to see a "See also" when there are other pages to link to. So thought, so fixed!

I confess that the links I put in the See also already exist in the content area and in the template. I think there are better examples (maybe externally to MediaWiki help pages?) but for now, there is something.--Chris collman 19:13, 25 May 2009 (UTC)