discuss@lists.openscad.org

OpenSCAD general discussion Mailing-list

View all threads

Request: Links in comments

T
Troberg
Fri, Nov 6, 2020 11:18 AM

OpenSCAD doesn't have the "project" thinking of typical dev environments,
it's just one file (and possible includes).

This is fine and keeps things clean, but a typical project still has a bunch
or related files. Photos, drawings, spreadsheets with measurements,
todo-lists and so on.

A very simple way to keep all this neat and organized would be to let the
editor parse links in comments, and open them when clicked (probably through
a context menu).

So, for example, these comments would be a clickable links:

//file://x:\proj\myproj\todo.txt
//file://x:\proj\myproj\oldpartphoto.jpg
//http://www.somesite.com/specs.html

When clicked, simply use whatever program the user has associated with the
content type, which, in all OS's I've tried, is a simple API call.

If it would make parsing easier, it's OK to add some extra syntax, such as,
for example:
//relatedfile<file://x:\proj\myproj\todo.txt)

I would find this immensely useful when things start getting big and
complicated.

--
Sent from: http://forum.openscad.org/

OpenSCAD doesn't have the "project" thinking of typical dev environments, it's just one file (and possible includes). This is fine and keeps things clean, but a typical project still has a bunch or related files. Photos, drawings, spreadsheets with measurements, todo-lists and so on. A very simple way to keep all this neat and organized would be to let the editor parse links in comments, and open them when clicked (probably through a context menu). So, for example, these comments would be a clickable links: //file://x:\proj\myproj\todo.txt //file://x:\proj\myproj\oldpartphoto.jpg //http://www.somesite.com/specs.html When clicked, simply use whatever program the user has associated with the content type, which, in all OS's I've tried, is a simple API call. If it would make parsing easier, it's OK to add some extra syntax, such as, for example: //relatedfile<file://x:\proj\myproj\todo.txt) I would find this immensely useful when things start getting big and complicated. -- Sent from: http://forum.openscad.org/
NH
nop head
Fri, Nov 6, 2020 12:05 PM

I have implemented that in my python framework. Comments that start with
//! get extracted and put in the readme.md markdown document that gets
rendered to HTML. So links and pictures work and any other markdown syntax.

On Fri, 6 Nov 2020 at 11:19, Troberg troberg.anders@gmail.com wrote:

OpenSCAD doesn't have the "project" thinking of typical dev environments,
it's just one file (and possible includes).

This is fine and keeps things clean, but a typical project still has a
bunch
or related files. Photos, drawings, spreadsheets with measurements,
todo-lists and so on.

A very simple way to keep all this neat and organized would be to let the
editor parse links in comments, and open them when clicked (probably
through
a context menu).

So, for example, these comments would be a clickable links:

//file://x:\proj\myproj\todo.txt
//file://x:\proj\myproj\oldpartphoto.jpg
//http://www.somesite.com/specs.html

When clicked, simply use whatever program the user has associated with the
content type, which, in all OS's I've tried, is a simple API call.

If it would make parsing easier, it's OK to add some extra syntax, such as,
for example:
//relatedfile<file://x:\proj\myproj\todo.txt)

I would find this immensely useful when things start getting big and
complicated.

--
Sent from: http://forum.openscad.org/


OpenSCAD mailing list
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org

I have implemented that in my python framework. Comments that start with //! get extracted and put in the readme.md markdown document that gets rendered to HTML. So links and pictures work and any other markdown syntax. On Fri, 6 Nov 2020 at 11:19, Troberg <troberg.anders@gmail.com> wrote: > OpenSCAD doesn't have the "project" thinking of typical dev environments, > it's just one file (and possible includes). > > This is fine and keeps things clean, but a typical project still has a > bunch > or related files. Photos, drawings, spreadsheets with measurements, > todo-lists and so on. > > A very simple way to keep all this neat and organized would be to let the > editor parse links in comments, and open them when clicked (probably > through > a context menu). > > So, for example, these comments would be a clickable links: > > //file://x:\proj\myproj\todo.txt > //file://x:\proj\myproj\oldpartphoto.jpg > //http://www.somesite.com/specs.html > > When clicked, simply use whatever program the user has associated with the > content type, which, in all OS's I've tried, is a simple API call. > > If it would make parsing easier, it's OK to add some extra syntax, such as, > for example: > //relatedfile<file://x:\proj\myproj\todo.txt) > > I would find this immensely useful when things start getting big and > complicated. > > > > -- > Sent from: http://forum.openscad.org/ > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >
T
Troberg
Sat, Nov 7, 2020 7:51 AM

nophead wrote

I have implemented that in my python framework. Comments that start with
//! get extracted and put in the readme.md markdown document that gets
rendered to HTML. So links and pictures work and any other markdown
syntax.

Hmm, I already do something like that, though I don't render it in HTML, and
I only use it to generate documentation for my parts libraries. I might
adapt that code...

Still, it would be nice to have it directly in the code editor. OpenSCAD
tends to become cumbersome when projects become large and complicated, as
I'm sure you've noticed, given the stuff you do.

--
Sent from: http://forum.openscad.org/

nophead wrote > I have implemented that in my python framework. Comments that start with > //! get extracted and put in the readme.md markdown document that gets > rendered to HTML. So links and pictures work and any other markdown > syntax. Hmm, I already do something like that, though I don't render it in HTML, and I only use it to generate documentation for my parts libraries. I might adapt that code... Still, it would be nice to have it directly in the code editor. OpenSCAD tends to become cumbersome when projects become large and complicated, as I'm sure you've noticed, given the stuff you do. -- Sent from: http://forum.openscad.org/
NH
nop head
Sat, Nov 7, 2020 8:29 AM

I don't use the internal editor for my projects. I only use it for code
snippets appearing on this mailing list, or perhaps to locate a syntax
error when I am being dense.

On Sat, 7 Nov 2020 at 07:52, Troberg troberg.anders@gmail.com wrote:

nophead wrote

I have implemented that in my python framework. Comments that start with
//! get extracted and put in the readme.md markdown document that gets
rendered to HTML. So links and pictures work and any other markdown
syntax.

Hmm, I already do something like that, though I don't render it in HTML,
and
I only use it to generate documentation for my parts libraries. I might
adapt that code...

Still, it would be nice to have it directly in the code editor. OpenSCAD
tends to become cumbersome when projects become large and complicated, as
I'm sure you've noticed, given the stuff you do.

--
Sent from: http://forum.openscad.org/


OpenSCAD mailing list
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org

I don't use the internal editor for my projects. I only use it for code snippets appearing on this mailing list, or perhaps to locate a syntax error when I am being dense. On Sat, 7 Nov 2020 at 07:52, Troberg <troberg.anders@gmail.com> wrote: > nophead wrote > > I have implemented that in my python framework. Comments that start with > > //! get extracted and put in the readme.md markdown document that gets > > rendered to HTML. So links and pictures work and any other markdown > > syntax. > > Hmm, I already do something like that, though I don't render it in HTML, > and > I only use it to generate documentation for my parts libraries. I might > adapt that code... > > Still, it would be nice to have it directly in the code editor. OpenSCAD > tends to become cumbersome when projects become large and complicated, as > I'm sure you've noticed, given the stuff you do. > > > > -- > Sent from: http://forum.openscad.org/ > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >
T
Troberg
Sat, Nov 7, 2020 9:41 AM

nophead wrote

I don't use the internal editor for my projects. I only use it for code
snippets appearing on this mailing list, or perhaps to locate a syntax
error when I am being dense.

Good point. Maybe this can all be solved by using an external IDE. Perhaps,
say, Eclipse could be cusomized for the purpose...

--
Sent from: http://forum.openscad.org/

nophead wrote > I don't use the internal editor for my projects. I only use it for code > snippets appearing on this mailing list, or perhaps to locate a syntax > error when I am being dense. Good point. Maybe this can all be solved by using an external IDE. Perhaps, say, Eclipse could be cusomized for the purpose... -- Sent from: http://forum.openscad.org/