LB
L Boyd
Mon, Sep 14, 2015 12:17 PM
Just edited 2D objects in the manual, adding some example statements which
create the object show in a picture.
From my programming background I want to, but have not, call these
statements code.
Given that OpenSCAD is not a programming language, is this an acceptable
term to use in the manual, or is there a better term?
--
View this message in context: http://forum.openscad.org/Code-tp13820.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
Just edited 2D objects in the manual, adding some example statements which
create the object show in a picture.
>From my programming background I want to, but have not, call these
statements code.
Given that OpenSCAD is not a programming language, is this an acceptable
term to use in the manual, or is there a better term?
--
View this message in context: http://forum.openscad.org/Code-tp13820.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
TP
Torsten Paul
Mon, Sep 14, 2015 1:25 PM
On 09/14/2015 02:17 PM, L Boyd wrote:
Just edited 2D objects in the manual, adding some example statements which
create the object show in a picture.
Nice, I've accepted the changes.
I'd personally would put the parameter description first and
the various examples after that ;-).
From my programming background I want to, but have not, call these
statements code.
Given that OpenSCAD is not a programming language, is this an acceptable
term to use in the manual, or is there a better term?
Hmm, the manual says: "...which is based on a Functional
programming language used to create models..." and the
about page "...reads in a script file that describes the
object and renders the 3D model from this script file".
So I guess both "code" and/or "script" are fine as they
are already used in other places.
ciao,
Torsten.
On 09/14/2015 02:17 PM, L Boyd wrote:
> Just edited 2D objects in the manual, adding some example statements which
> create the object show in a picture.
>
Nice, I've accepted the changes.
I'd personally would put the parameter description first and
the various examples after that ;-).
> From my programming background I want to, but have not, call these
> statements code.
>
> Given that OpenSCAD is not a programming language, is this an acceptable
> term to use in the manual, or is there a better term?
>
Hmm, the manual says: "...which is based on a Functional
programming language used to create models..." and the
about page "...reads in a script file that describes the
object and renders the 3D model from this script file".
So I guess both "code" and/or "script" are fine as they
are already used in other places.
ciao,
Torsten.
LB
L Boyd
Mon, Sep 14, 2015 6:37 PM
As far as the order, I think it depends on you perspective.
For some one with experience, the manual is used as a reference. Your
preferred order is better for this purpose.
For someone new, trying to feel their way around, a different order is
useful.
The picture best conveys if this is the desired object.
If so, then example code is the next desire.
The parameter descriptions are needed but are the last concern.
Also, when looking at the picture, it is distracting to have the next object
directly under the picture.
Perhaps others can weigh in with their opinion.
--
View this message in context: http://forum.openscad.org/Code-tp13820p13829.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
As far as the order, I think it depends on you perspective.
For some one with experience, the manual is used as a reference. Your
preferred order is better for this purpose.
For someone new, trying to feel their way around, a different order is
useful.
The picture best conveys if this is the desired object.
If so, then example code is the next desire.
The parameter descriptions are needed but are the last concern.
Also, when looking at the picture, it is distracting to have the next object
directly under the picture.
Perhaps others can weigh in with their opinion.
--
View this message in context: http://forum.openscad.org/Code-tp13820p13829.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
M
MichaelAtOz
Mon, Sep 14, 2015 8:32 PM
The manual is a reference IMO.
Much, not all, of the manual is in reference style.
There are lots of how-to's, I don't think that should be the prime role of
this manual.
Unless someone want to create a core, purely syntactic, reference manual
separately.
Newly minted Admin - PM me if you need anything, or if I've done something stupid...
Unless specifically shown otherwise above, my contribution is in the Public Domain; to the extent possible under law, I have waived all copyright and related or neighbouring rights to this work. Obviously inclusion of works of previous authors is not included in the above.
The TPP is no simple “trade agreement.” Fight it! http://www.ourfairdeal.org/ time is running out!
View this message in context: http://forum.openscad.org/Code-tp13820p13831.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
The manual is a reference IMO.
Much, not all, of the manual is in reference style.
There are lots of how-to's, I don't think that should be the prime role of
this manual.
Unless someone want to create a core, purely syntactic, reference manual
separately.
-----
Newly minted Admin - PM me if you need anything, or if I've done something stupid...
Unless specifically shown otherwise above, my contribution is in the Public Domain; to the extent possible under law, I have waived all copyright and related or neighbouring rights to this work. Obviously inclusion of works of previous authors is not included in the above.
The TPP is no simple “trade agreement.” Fight it! http://www.ourfairdeal.org/ time is running out!
--
View this message in context: http://forum.openscad.org/Code-tp13820p13831.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
LB
L Boyd
Tue, Sep 15, 2015 12:25 PM
Valid point. The next time I edit the page I will rearrange it.
I used the manual for learning because it was what I could find. Where does
one find the how-to's?
--
View this message in context: http://forum.openscad.org/Code-tp13820p13842.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
Valid point. The next time I edit the page I will rearrange it.
I used the manual for learning because it was what I could find. Where does
one find the how-to's?
--
View this message in context: http://forum.openscad.org/Code-tp13820p13842.html
Sent from the OpenSCAD mailing list archive at Nabble.com.
TH
Tim Hawkins
Tue, Sep 15, 2015 12:34 PM
You could use the term "markup", I tend to think of openscad as a scripting
language attached to a 3d model format, in a simular way that javascript
interacts with the html DOM.
On Mon, Sep 14, 2015, 20:18 L Boyd lboyd@frontiernet.net wrote:
You could use the term "markup", I tend to think of openscad as a scripting
language attached to a 3d model format, in a simular way that javascript
interacts with the html DOM.
On Mon, Sep 14, 2015, 20:18 L Boyd <lboyd@frontiernet.net> wrote:
> Just edited 2D objects in the manual, adding some example statements which
> create the object show in a picture.
> From my programming background I want to, but have not, call these
> statements code.
>
> Given that OpenSCAD is not a programming language, is this an acceptable
> term to use in the manual, or is there a better term?
>
>
>
> --
> View this message in context: http://forum.openscad.org/Code-tp13820.html
> Sent from the OpenSCAD mailing list archive at Nabble.com.
>
> _______________________________________________
> OpenSCAD mailing list
> Discuss@lists.openscad.org
> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
>
MK
Marius Kintel
Tue, Sep 15, 2015 2:35 PM
Given that OpenSCAD is not a programming language, is this an acceptable
term to use in the manual, or is there a better term?
Even though OpenSCAD is a turing complete programming language, we’ve tried to sell it as a description language, to reduce the amounts of complaints about feature completeness vs. other languages. Otoh, “programming language” is a good description when talking to non-professionals. Rather than having official terms, we could perhaps just call it whatever we feel like depending on context, and do a writeup in the manual explaining the execution model to people who’re interested?
-Marius
On Sep 14, 2015, at 08:17 AM, L Boyd <lboyd@frontiernet.net> wrote:
>
> Given that OpenSCAD is not a programming language, is this an acceptable
> term to use in the manual, or is there a better term?
>
Even though OpenSCAD _is_ a turing complete programming language, we’ve tried to sell it as a description language, to reduce the amounts of complaints about feature completeness vs. other languages. Otoh, “programming language” is a good description when talking to non-professionals. Rather than having official terms, we could perhaps just call it whatever we feel like depending on context, and do a writeup in the manual explaining the execution model to people who’re interested?
-Marius
DM
doug moen
Tue, Sep 15, 2015 3:28 PM
"Markup" means annotations that are added to a text document, which
describe how the text is to be formatted. OpenSCAD is not a markup language.
The word "code" is just fine.
On 15 September 2015 at 08:34, Tim Hawkins tim.thawkins@gmail.com wrote:
You could use the term "markup", I tend to think of openscad as a
scripting language attached to a 3d model format, in a simular way that
javascript interacts with the html DOM.
On Mon, Sep 14, 2015, 20:18 L Boyd lboyd@frontiernet.net wrote:
"Markup" means annotations that are added to a text document, which
describe how the text is to be formatted. OpenSCAD is not a markup language.
The word "code" is just fine.
On 15 September 2015 at 08:34, Tim Hawkins <tim.thawkins@gmail.com> wrote:
> You could use the term "markup", I tend to think of openscad as a
> scripting language attached to a 3d model format, in a simular way that
> javascript interacts with the html DOM.
>
> On Mon, Sep 14, 2015, 20:18 L Boyd <lboyd@frontiernet.net> wrote:
>
>> Just edited 2D objects in the manual, adding some example statements which
>> create the object show in a picture.
>> From my programming background I want to, but have not, call these
>> statements code.
>>
>> Given that OpenSCAD is not a programming language, is this an acceptable
>> term to use in the manual, or is there a better term?
>>
>>
>>
>> --
>> View this message in context: http://forum.openscad.org/Code-tp13820.html
>> Sent from the OpenSCAD mailing list archive at Nabble.com.
>>
>> _______________________________________________
>> OpenSCAD mailing list
>> Discuss@lists.openscad.org
>> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
>>
>
> _______________________________________________
> OpenSCAD mailing list
> Discuss@lists.openscad.org
> http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org
>
>
