POV-Ray : Newsgroups : povray.documentation.inbuilt : Request for assistance with documentation Server Time: 20 Apr 2014 11:04:04 GMT
  Request for assistance with documentation (Message 1 to 10 of 15)  
Goto Latest 10 Messages Next 5 Messages >>>
From: Chris Cason
Subject: Request for assistance with documentation
Date: 28 Feb 2010 13:44:26
Message: <4b8a733a@news.povray.org>
Folks,

If we ever want to get POV-Ray v3.7 done, we must get the documentation
updated. This is something we need community assistance with; it's not a
big job provided enough people pitch in. I've asked James Holsenback to
co-ordinate this work and he has kindly agreed. We have set up a wiki-based
framework that allows collaborative editing with export to
the final documentation to be done via some scripts.

The list of 'To Do' items can be found here:

  http://wiki.povray.org/content/Documentation:ToDo

Ideally if we can get at least half-a-dozen folks serious in helping on
this, it would break the job down into manageable pieces.

If you'd like to volunteer, please followup to this posting and also drop
an email to Jim via jholsenback at [deletethis]povray.org.

thanks in advance,

-- Chris Cason
   Team co-ordinator


Post a reply to this message

From: Jim Holsenback
Subject: Re: Request for assistance with documentation
Date: 10 Mar 2010 22:07:18
Message: <4b981816$1@news.povray.org>
On Mon, 01 Mar 2010 00:44:22 +1100, Chris Cason wrote:

> The list of 'To Do' items can be found here:
> 
>   http://wiki.povray.org/content/Documentation:ToDo

I've added an assigned/completed tasks section to:
http://wiki.povray.org/content/Documentation:ToDo#Assigned_Tasks

Jim


Post a reply to this message

From: Jaap Frank
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 13:23:01
Message: <4d383735$1@news.povray.org>
This piece of added text is a proposal to add to the documentation, because 
this is possible with arrays.
The documentation gives no hint for this advanced use of arrays.
I know that very few users of POVRay are aware of it.
It can be added as point 3.2.1.8.3 Advanced use of Arrays.
Because English is not my native language it may be wise that someone checks 
this text and then put it it in the documentation as proposal. I don't know 
how to do that.


Regards,

Jaap Frank


Post a reply to this message


Attachments:
Download 'us-ascii' (4 KB)
Download 'array_diagram.jpg' (107 KB)

Preview of image 'array_diagram.jpg'
array_diagram.jpg


 

From: Jaap Frank
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 13:34:09
Message: <4d3839d1$1@news.povray.org>
Sorry, I didn't noticed it's coupled to three places. 
Can someone remove the ones in p.beta-test and p.general? 
I don't know how to do that.

Jaap Frank


Post a reply to this message

From: Jim Holsenback
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 13:40:49
Message: <4d383b61$1@news.povray.org>
On 01/20/2011 09:23 AM, Jaap Frank wrote:
> This piece of added text is a proposal to add to the documentation,
> because this is possible with arrays.
> The documentation gives no hint for this advanced use of arrays.
> I know that very few users of POVRay are aware of it.
> It can be added as point 3.2.1.8.3 Advanced use of Arrays.
> Because English is not my native language it may be wise that someone
> checks this text and then put it it in the documentation as proposal. I
> don't know how to do that.

At:
http://wiki.povray.org/content/Documentation:Reference_Section_2.3#Declaring_Arrays

the syntax diagram DOES mention the capability but there is little to no
expansion on this concept. Is that what you're getting at? I'm not 1000%
sure that the documentation is the correct place, but hey I might be
persuaded to bow to the majority opinion ... maybe a KB "How To" article
on the wiki might be a better choice


Post a reply to this message

From: Jaap Frank
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 14:20:36
Message: <4d3844b4@news.povray.org>
>"Jim Holsenback"  schreef in bericht news:4d383b61$1@news.povray.org...
>
>On 01/20/2011 09:23 AM, Jaap Frank wrote:
>> This piece of added text is a proposal to add to the documentation,
>> because this is possible with arrays.
>> The documentation gives no hint for this advanced use of arrays.
>> I know that very few users of POVRay are aware of it.
>> It can be added as point 3.2.1.8.3 Advanced use of Arrays.
>> Because English is not my native language it may be wise that someone
>> checks this text and then put it it in the documentation as proposal. I
>> don't know how to do that.
>
>At:
>http://wiki.povray.org/content/Documentation:Reference_Section_2.3#Declaring_Arrays
>
>the syntax diagram DOES mention the capability but there is little to no
>expansion on this concept. Is that what you're getting at? I'm not 1000%
>sure that the documentation is the correct place, but hey I might be
>persuaded to bow to the majority opinion ... maybe a KB "How To" article
>on the wiki might be a better choice

If you know it is possible to put arrays inside arrays, then you can read it 
between the lines, but it's not explicitly mentioned.
Even clipka wasn't aware of it and was convinced that it was not possible, 
see his reaction in this thread:

http://news.povray.org/povray.text.tutorials/thread/%3Cweb.4ab771232793170f772dd76f0%40news.povray.org%3E/

A link in the documentation to the wiki is naturally another possibility.


Post a reply to this message

From: Warp
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 15:46:07
Message: <4d3858bf@news.povray.org>
In povray.general Jaap Frank <jjfrank [at] casemanl> wrote:
> If you know it is possible to put arrays inside arrays, then you can read it 
> between the lines, but it's not explicitly mentioned.

  Since basically anything that can be #declared can also be put into an
array, it would be very strange if arrays made an odd exception to this
generic rule.

  If it has to be specified explicitly, I don't think it deserves more
than a single sentence in the documentation (something along the lines
of "you can create a multidimensional array by making an array of arrays").

-- 
                                                          - Warp


Post a reply to this message

From: Jim Holsenback
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 15:58:21
Message: <4d385b9d$1@news.povray.org>
On 01/20/2011 11:46 AM, Warp wrote:
> In povray.general Jaap Frank <jjfrank [at] casemanl> wrote:
>> If you know it is possible to put arrays inside arrays, then you can read it 
>> between the lines, but it's not explicitly mentioned.
> 
>   Since basically anything that can be #declared can also be put into an
> array, it would be very strange if arrays made an odd exception to this
> generic rule.
> 
>   If it has to be specified explicitly, I don't think it deserves more
> than a single sentence in the documentation (something along the lines
> of "you can create a multidimensional array by making an array of arrays").
> 
agreed ... any expansion on the theme should come from the user
community (how to article)


Post a reply to this message

From: Jim Holsenback
Subject: Re: Proposal to expand the documentation about Arrays
Date: 20 Jan 2011 22:16:48
Message: <4d38b450$1@news.povray.org>
On 01/20/2011 11:46 AM, Warp wrote:
>   If it has to be specified explicitly, I don't think it deserves more
> than a single sentence in the documentation (something along the lines
> of "you can create a multidimensional array by making an array of arrays").
> 

it's been done ...


Post a reply to this message

From: Jaap Frank
Subject: Re: Proposal to expand the documentation about Arrays
Date: 21 Jan 2011 08:43:14
Message: <4d394722@news.povray.org>
>"Jim Holsenback"  schreef in bericht news:4d38b450$1@news.povray.org...
>
>On 01/20/2011 11:46 AM, Warp wrote:
>>   If it has to be specified explicitly, I don't think it deserves more
>> than a single sentence in the documentation (something along the lines
>> of "you can create a multidimensional array by making an array of 
>> arrays").
>>
>
>it's been done ...

Can you change that in "you can create a multidimensional or
                                        multivariable array by making an 
array of arrays"
because the multi variable part is the interesting tric.
By the way, I've looked at the wiki, but you have to do that in html-style I
suppose and I'm not familiar with html or is there an easy way to do that.


Post a reply to this message

Goto Latest 10 Messages Next 5 Messages >>>

Copyright 2003-2008 Persistence of Vision Raytracer Pty. Ltd.