discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

conflicting manual entries

W
wolf
Sun, Mar 13, 2016 7:39 PM
For rotate_extrude (and linear extrude) there are four entries into to manual: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude_2 https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2 These four entries do not agree with each other on usage. wolf -- View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Mon, Mar 14, 2016 3:34 PM

There aren't actually 4 separate copies. The page titled "Using the 2D
Subsystem" actually transcludes its text from somewhere else.

https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2

However, in order to eliminate any confusion, I've marked this page for
deletion, and added a forwarding link to the language manual. (I don't know
how to actually delete a page.)

So, that gets rid of two of the duplicate entries.

On 13 March 2016 at 15:39, wolf wv99999@gmail.com wrote:

There aren't actually 4 separate copies. The page titled "Using the 2D Subsystem" actually transcludes its text from somewhere else. https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem <https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2> However, in order to eliminate any confusion, I've marked this page for deletion, and added a forwarding link to the language manual. (I don't know how to actually delete a page.) So, that gets rid of two of the duplicate entries. On 13 March 2016 at 15:39, wolf <wv99999@gmail.com> wrote: > For rotate_extrude (and linear extrude) there are four entries into to > manual: > > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude_2 > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2 > > These four entries do not agree with each other on usage. > > wolf > > > > -- > View this message in context: > http://forum.openscad.org/conflicting-manual-entries-tp16467.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 > > >
DM
doug moen
Mon, Mar 14, 2016 4:01 PM

By doing this, I've actually broken the openscad.org website, because
http://www.openscad.org/documentation.html contains a link to the page I
marked for deletion. That's fixable on github.

Here are some more web pages that link to the page I marked for deletion: a
couple forum posts, a bunch of blog posts, maybe 20 in all:
linkto:
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem

Anybody want to argue that I should revert the change?

Here's another page containing obsolete, duplicate documentation for
rotate_extrude and linear_extrude:
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version

On 14 March 2016 at 11:34, doug moen doug@moens.org wrote:

There aren't actually 4 separate copies. The page titled "Using the 2D
Subsystem" actually transcludes its text from somewhere else.

https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2

However, in order to eliminate any confusion, I've marked this page for
deletion, and added a forwarding link to the language manual. (I don't know
how to actually delete a page.)

So, that gets rid of two of the duplicate entries.

On 13 March 2016 at 15:39, wolf wv99999@gmail.com wrote:

By doing this, I've actually broken the openscad.org website, because http://www.openscad.org/documentation.html contains a link to the page I marked for deletion. That's fixable on github. Here are some more web pages that link to the page I marked for deletion: a couple forum posts, a bunch of blog posts, maybe 20 in all: linkto: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem Anybody want to argue that I should revert the change? Here's another page containing obsolete, duplicate documentation for rotate_extrude and linear_extrude: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Print_version On 14 March 2016 at 11:34, doug moen <doug@moens.org> wrote: > There aren't actually 4 separate copies. The page titled "Using the 2D > Subsystem" actually transcludes its text from somewhere else. > > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem > <https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2> > > However, in order to eliminate any confusion, I've marked this page for > deletion, and added a forwarding link to the language manual. (I don't know > how to actually delete a page.) > > So, that gets rid of two of the duplicate entries. > > On 13 March 2016 at 15:39, wolf <wv99999@gmail.com> wrote: > >> For rotate_extrude (and linear extrude) there are four entries into to >> manual: >> >> >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude >> >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/The_OpenSCAD_Language#Rotate_Extrude_2 >> >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude >> >> https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem#Rotate_Extrude_2 >> >> These four entries do not agree with each other on usage. >> >> wolf >> >> >> >> -- >> View this message in context: >> http://forum.openscad.org/conflicting-manual-entries-tp16467.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 >> >> >> >
A
ajs
Mon, Mar 14, 2016 11:05 PM

All the broken links redirecting to the same place, including on the cheat
sheet are killing me, and I'm sure any other newbies are being driven crazy.
Not sure about the original issue but I vote to revert back.

--
View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16498.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

All the broken links redirecting to the same place, including on the cheat sheet are killing me, and I'm sure any other newbies are being driven crazy. Not sure about the original issue but I vote to revert back. -- View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16498.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Mon, Mar 14, 2016 11:24 PM

Okay, I just reverted those changes. Two people notified me that I broke
the cheatsheet.

Fixing the cheatsheet to point into the language reference manual is a
longer term goal, but this was an emergency action.

On 14 March 2016 at 19:05, ajs a.j.scaraggi@gmail.com wrote:

All the broken links redirecting to the same place, including on the cheat
sheet are killing me, and I'm sure any other newbies are being driven
crazy.
Not sure about the original issue but I vote to revert back.

--
View this message in context:
http://forum.openscad.org/conflicting-manual-entries-tp16467p16498.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

Okay, I just reverted those changes. Two people notified me that I broke the cheatsheet. Fixing the cheatsheet to point into the language reference manual is a longer term goal, but this was an emergency action. On 14 March 2016 at 19:05, ajs <a.j.scaraggi@gmail.com> wrote: > All the broken links redirecting to the same place, including on the cheat > sheet are killing me, and I'm sure any other newbies are being driven > crazy. > Not sure about the original issue but I vote to revert back. > > > > -- > View this message in context: > http://forum.openscad.org/conflicting-manual-entries-tp16467p16498.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
Wed, Mar 16, 2016 5:19 AM

Thanks for reporting and caring:)

FYI: Both the cheatsheet and the Manual table of contents on http://www.openscad.org/documentation.html links to the manual.
I believe these are the only two public deep links into the manual, so updating these first would make sense. They’re both a github repo (https://github.com/openscad/openscad.github.com).

-Marius

Thanks for reporting and caring:) FYI: Both the cheatsheet and the Manual table of contents on http://www.openscad.org/documentation.html links to the manual. I believe these are the only two public deep links into the manual, so updating these first would make sense. They’re both a github repo (https://github.com/openscad/openscad.github.com). -Marius
LB
L Boyd
Wed, Mar 16, 2016 8:56 PM

First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets you
to the same text.

The basic problem is duplicate headings in different sections of the manual.
This is true for both Rotate Extrude and Linear Extrude.

The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is the
most extensive and should be retained.

Under "DXF Extrusion" reached via  #Rotate_Extrude_2, the information is
very limited.

What needs to happen:

  1. If the "DXF Extrusion" section has anything useful not currently part
    "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section.

  2. Once this is done, all the "DXF Extrusion" section should be deleted.
    Since the index is automatically created by WikiBooks, deleting a section
    removes it from the index along with any links to that section.

The CheatSheet links to the "2D to 3D Extrusion" section, so its links will
remain good.

By the way, I remember something about a limit of how many levels of
redirect WikiBooks will processing. Adding one more to the ones already used
probably exceed this limit


Larry

View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets you to the same text. The basic problem is duplicate headings in different sections of the manual. This is true for both Rotate Extrude and Linear Extrude. The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is the most extensive and should be retained. Under "DXF Extrusion" reached via #Rotate_Extrude_2, the information is very limited. What needs to happen: 1. If the "DXF Extrusion" section has anything useful not currently part "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section. 2. Once this is done, all the "DXF Extrusion" section should be deleted. Since the index is automatically created by WikiBooks, deleting a section removes it from the index along with any links to that section. The CheatSheet links to the "2D to 3D Extrusion" section, so its links will remain good. By the way, I remember something about a limit of how many levels of redirect WikiBooks will processing. Adding one more to the ones already used probably exceed this limit ----- Larry -- View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.html Sent from the OpenSCAD mailing list archive at Nabble.com.
LB
L Boyd
Wed, Mar 16, 2016 9:15 PM

Actually the duplicate names are not a problem per say, as WikiBooks handles
it fine. The problem is the confusion of having 2 places in the manual with
different information about the same topic.


Larry

View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16502.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

Actually the duplicate names are not a problem per say, as WikiBooks handles it fine. The problem is the confusion of having 2 places in the manual with different information about the same topic. ----- Larry -- View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16502.html Sent from the OpenSCAD mailing list archive at Nabble.com.
DM
doug moen
Thu, Mar 17, 2016 9:33 PM

The chapter titled "2D Objects" was transcluding the same sections multiple
times. The sections on Text, Linear Extrude and Rotate Extrude were all
duplicated, with duplicated entries in the table of contents as well. So I
fixed that.

The original report claimed that there multiple conflicting definitions of
rotate_extrude. I only see one definition in the Language manual right now,
plus a bunch of examples. The definition (usage) says:

rotate_extrude(angle = 360, convexity = 2) {...}

Several examples use the $fn= argument, which isn't documented in the usage
section. Not fixed.

There is an example of rotate_extrude() in the DXF Extrusion section which
gives a twist= parameter, which is wrong, so I fixed that.

I don't see any evidence of "conflicting definitions" for linear_extrude,
other than $fn=,$fa=,$fs= not being mentioned in the definition, only in
examples.

There's still more to do, but that's an improvement anyway.

Doug Moen

On 16 March 2016 at 16:56, L Boyd lboyd@frontiernet.net wrote:

First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets
you
to the same text.

The basic problem is duplicate headings in different sections of the
manual.
This is true for both Rotate Extrude and Linear Extrude.

The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is
the
most extensive and should be retained.

Under "DXF Extrusion" reached via  #Rotate_Extrude_2, the information is
very limited.

What needs to happen:

  1. If the "DXF Extrusion" section has anything useful not currently part
    "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section.

  2. Once this is done, all the "DXF Extrusion" section should be deleted.
    Since the index is automatically created by WikiBooks, deleting a section
    removes it from the index along with any links to that section.

The CheatSheet links to the "2D to 3D Extrusion" section, so its links will
remain good.

By the way, I remember something about a limit of how many levels of
redirect WikiBooks will processing. Adding one more to the ones already
used
probably exceed this limit


Larry

View this message in context:
http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.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

The chapter titled "2D Objects" was transcluding the same sections multiple times. The sections on Text, Linear Extrude and Rotate Extrude were all duplicated, with duplicated entries in the table of contents as well. So I fixed that. The original report claimed that there multiple conflicting definitions of rotate_extrude. I only see one definition in the Language manual right now, plus a bunch of examples. The definition (usage) says: rotate_extrude(angle = 360, convexity = 2) {...} Several examples use the $fn= argument, which isn't documented in the usage section. Not fixed. There is an example of rotate_extrude() in the DXF Extrusion section which gives a twist= parameter, which is wrong, so I fixed that. I don't see any evidence of "conflicting definitions" for linear_extrude, other than $fn=,$fa=,$fs= not being mentioned in the definition, only in examples. There's still more to do, but that's an improvement anyway. Doug Moen On 16 March 2016 at 16:56, L Boyd <lboyd@frontiernet.net> wrote: > First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets > you > to the same text. > > The basic problem is duplicate headings in different sections of the > manual. > This is true for both Rotate Extrude and Linear Extrude. > > The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is > the > most extensive and should be retained. > > Under "DXF Extrusion" reached via #Rotate_Extrude_2, the information is > very limited. > > What needs to happen: > 1. If the "DXF Extrusion" section has anything useful not currently part > "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section. > > 2. Once this is done, all the "DXF Extrusion" section should be deleted. > Since the index is automatically created by WikiBooks, deleting a section > removes it from the index along with any links to that section. > > The CheatSheet links to the "2D to 3D Extrusion" section, so its links will > remain good. > > By the way, I remember something about a limit of how many levels of > redirect WikiBooks will processing. Adding one more to the ones already > used > probably exceed this limit > > > > > ----- > Larry > -- > View this message in context: > http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.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 > > >
DM
doug moen
Thu, Mar 17, 2016 10:24 PM

Removed incorrect and redundant text from the DXF Extrusion document. I'm
not going to delete the document itself because there could be links to it.

The only remaining useful information in the document is some links to
tutorials on how to export DXF files from Inkscape.

The DXF Extrusion document doesn't need to transcluded by the Language
Manual (it's already transcluded by the User Manual) so I've removed it
from the Language Manual.

On 17 March 2016 at 17:33, doug moen doug@moens.org wrote:

The chapter titled "2D Objects" was transcluding the same sections
multiple times. The sections on Text, Linear Extrude and Rotate Extrude
were all duplicated, with duplicated entries in the table of contents as
well. So I fixed that.

The original report claimed that there multiple conflicting definitions of
rotate_extrude. I only see one definition in the Language manual right now,
plus a bunch of examples. The definition (usage) says:

rotate_extrude(angle = 360, convexity = 2) {...}

Several examples use the $fn= argument, which isn't documented in the
usage section. Not fixed.

There is an example of rotate_extrude() in the DXF Extrusion section which
gives a twist= parameter, which is wrong, so I fixed that.

I don't see any evidence of "conflicting definitions" for linear_extrude,
other than $fn=,$fa=,$fs= not being mentioned in the definition, only in
examples.

There's still more to do, but that's an improvement anyway.

Doug Moen

On 16 March 2016 at 16:56, L Boyd lboyd@frontiernet.net wrote:

First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets
you
to the same text.

The basic problem is duplicate headings in different sections of the
manual.
This is true for both Rotate Extrude and Linear Extrude.

The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is
the
most extensive and should be retained.

Under "DXF Extrusion" reached via  #Rotate_Extrude_2, the information is
very limited.

What needs to happen:

  1. If the "DXF Extrusion" section has anything useful not currently
    part
    "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section.

  2. Once this is done, all the "DXF Extrusion" section should be deleted.
    Since the index is automatically created by WikiBooks, deleting a section
    removes it from the index along with any links to that section.

The CheatSheet links to the "2D to 3D Extrusion" section, so its links
will
remain good.

By the way, I remember something about a limit of how many levels of
redirect WikiBooks will processing. Adding one more to the ones already
used
probably exceed this limit


Larry

View this message in context:
http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.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

Removed incorrect and redundant text from the DXF Extrusion document. I'm not going to delete the document itself because there could be links to it. The only remaining useful information in the document is some links to tutorials on how to export DXF files from Inkscape. The DXF Extrusion document doesn't need to transcluded by the Language Manual (it's already transcluded by the User Manual) so I've removed it from the Language Manual. On 17 March 2016 at 17:33, doug moen <doug@moens.org> wrote: > The chapter titled "2D Objects" was transcluding the same sections > multiple times. The sections on Text, Linear Extrude and Rotate Extrude > were all duplicated, with duplicated entries in the table of contents as > well. So I fixed that. > > The original report claimed that there multiple conflicting definitions of > rotate_extrude. I only see one definition in the Language manual right now, > plus a bunch of examples. The definition (usage) says: > > rotate_extrude(angle = 360, convexity = 2) {...} > > > Several examples use the $fn= argument, which isn't documented in the > usage section. Not fixed. > > There is an example of rotate_extrude() in the DXF Extrusion section which > gives a twist= parameter, which is wrong, so I fixed that. > > I don't see any evidence of "conflicting definitions" for linear_extrude, > other than $fn=,$fa=,$fs= not being mentioned in the definition, only in > examples. > > There's still more to do, but that's an improvement anyway. > > Doug Moen > > On 16 March 2016 at 16:56, L Boyd <lboyd@frontiernet.net> wrote: > >> First of all, both The_OpenSCAD_Language and Using_the_2D_Subsystem gets >> you >> to the same text. >> >> The basic problem is duplicate headings in different sections of the >> manual. >> This is true for both Rotate Extrude and Linear Extrude. >> >> The discussion under "2D to 3D Extrusion" reached via #Rotate_Extrude is >> the >> most extensive and should be retained. >> >> Under "DXF Extrusion" reached via #Rotate_Extrude_2, the information is >> very limited. >> >> What needs to happen: >> 1. If the "DXF Extrusion" section has anything useful not currently >> part >> "2D to 3D Extrusion", it should added to the "2D to 3D Extrusion" section. >> >> 2. Once this is done, all the "DXF Extrusion" section should be deleted. >> Since the index is automatically created by WikiBooks, deleting a section >> removes it from the index along with any links to that section. >> >> The CheatSheet links to the "2D to 3D Extrusion" section, so its links >> will >> remain good. >> >> By the way, I remember something about a limit of how many levels of >> redirect WikiBooks will processing. Adding one more to the ones already >> used >> probably exceed this limit >> >> >> >> >> ----- >> Larry >> -- >> View this message in context: >> http://forum.openscad.org/conflicting-manual-entries-tp16467p16501.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 >> >> >> >