Discussion:
[Docutils-users] Question about substitution definitions as relating to figures
Suzanne Hillman
2017-05-04 01:26:01 UTC
Permalink
Hello everyone!

I'm back again. Again, please cc me on replies. :)

In looking at the substitution definitions (
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions),
I see that they include images and replacement text. As far as I can tell,
they do not include the possibility of substituting for figures.

Is this accurate? Do substitutions not yet allow you to substitute for
figures?

I also tried using replace for figures, but it didn't like that.

I couldn't figure out how to add a feature request, if in fact that's not
yet available.

Thanks,

Suzanne
David Goodger
2017-05-04 01:41:36 UTC
Permalink
Post by Suzanne Hillman
Hello everyone!
I'm back again. Again, please cc me on replies. :)
In looking at the substitution definitions
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions),
I see that they include images and replacement text. As far as I can tell,
they do not include the possibility of substituting for figures.
Is this accurate?
Yes, by definition. Substitutions are a phrase-level (within text)
construct, e.g. in the middle of a sentence. From the reST spec:
"Substitution definitions allow the power and flexibility of
block-level directives to be shared by inline text." Figures are
block-level elements (consisting of an image, and optionally a caption
and/or a legend), and thus cannot occur inside text.
Post by Suzanne Hillman
Do substitutions not yet allow you to substitute for
figures?
Correct, however they won't be added in future. One can't put a figure
inside a sentence.
Post by Suzanne Hillman
I also tried using replace for figures, but it didn't like that.
Only a subset of directives can be used in substitutions: image,
unicode, replace, date.
http://docutils.sourceforge.net/docs/ref/rst/directives.html#directives-for-substitution-definitions
Post by Suzanne Hillman
I couldn't figure out how to add a feature request, if in fact that's not
yet available.
https://sourceforge.net/p/docutils/feature-requests/

If you want to request this as a feature, you'll first have to
demonstrate how it would work. Please show an example of the reST
source, as well as indicate what the result would be.

What do you want to do in your document? Perhaps there's another way.

David Goodger
<http://python.net/~goodger>

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.
Suzanne Hillman
2017-05-05 15:55:44 UTC
Permalink
I'm trying to make a line of thumbnails with captions, and have headers
above some of them. I want both the thumbs and the captions to be links, as
well.

Something like this:

Reports

Competitive Analysis Contextual Interviews
Design Thinking Session
Figure one Figure two
Figure three Figure four
caption caption
caption caption

Basically, I'm looking to highlight various design artifacts within my
portfolio, and link those to the specific pages within the regular
portfolio so people can find whatever artifacts they are interested in
seeing my skill with without having to sort through a specific project. And
the 'Reports' section of this is complex enough that I'd prefer to make it
easier to interpret via the structure above.

Something sort of like the bottom of this page, but with captions and
headers: https://designattic.wordpress.com/

Does this make sense?

Sz
Post by Suzanne Hillman
Post by Suzanne Hillman
Hello everyone!
I'm back again. Again, please cc me on replies. :)
In looking at the substitution definitions
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#
substitution-definitions),
Post by Suzanne Hillman
I see that they include images and replacement text. As far as I can
tell,
Post by Suzanne Hillman
they do not include the possibility of substituting for figures.
Is this accurate?
Yes, by definition. Substitutions are a phrase-level (within text)
"Substitution definitions allow the power and flexibility of
block-level directives to be shared by inline text." Figures are
block-level elements (consisting of an image, and optionally a caption
and/or a legend), and thus cannot occur inside text.
Post by Suzanne Hillman
Do substitutions not yet allow you to substitute for
figures?
Correct, however they won't be added in future. One can't put a figure
inside a sentence.
Post by Suzanne Hillman
I also tried using replace for figures, but it didn't like that.
Only a subset of directives can be used in substitutions: image,
unicode, replace, date.
http://docutils.sourceforge.net/docs/ref/rst/directives.
html#directives-for-substitution-definitions
Post by Suzanne Hillman
I couldn't figure out how to add a feature request, if in fact that's not
yet available.
https://sourceforge.net/p/docutils/feature-requests/
If you want to request this as a feature, you'll first have to
demonstrate how it would work. Please show an example of the reST
source, as well as indicate what the result would be.
What do you want to do in your document? Perhaps there's another way.
David Goodger
<http://python.net/~goodger>
David Goodger
2017-05-05 16:20:22 UTC
Permalink
For what you can do in a structured way, take a look at
http://puzzler.sourceforge.net/docs/puzzles.html (link to the source
.txt at the bottom). This uses list-tables to organize the images. But
this structure above is very limited. For example, if the screen is
too small (e.g. on a phone display), that page needs to be scrolled
left/right, but it ought to reflow to adapt to the screen.

You might want to do something more free-form. I'm thinking of
changing that site to a dynamic CSS-driven display, maybe using the
columns (column-width, column-count) styles. I'm no expert on CSS
though. I recommend that you look around the web for examples of
layouts that you want to emulate, and look into their CSS to see how
they're done. Take a look at
https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Columns/Using_multi-column_layouts
and https://www.w3schools.com/css/tryit.asp?filename=trycss_image_gallery_responsive

Also, you may be approaching a limit of what reStructuredText can do
for you. You may need to use hand-tweaked HTML to get exactly the
effect you want. Or maybe Docutils-produced HTML along with good CSS
will do what you need. The "container" directive may be helpful (maybe
instead of "figure", which may be too formal for your use case).

David Goodger
<http://python.net/~goodger>
Post by Suzanne Hillman
I'm trying to make a line of thumbnails with captions, and have headers
above some of them. I want both the thumbs and the captions to be links, as
well.
Reports
Competitive Analysis Contextual Interviews
Design Thinking Session
Figure one Figure two
Figure three Figure four
caption caption
caption caption
Basically, I'm looking to highlight various design artifacts within my
portfolio, and link those to the specific pages within the regular portfolio
so people can find whatever artifacts they are interested in seeing my skill
with without having to sort through a specific project. And the 'Reports'
section of this is complex enough that I'd prefer to make it easier to
interpret via the structure above.
Something sort of like the bottom of this page, but with captions and
headers: https://designattic.wordpress.com/
Does this make sense?
Sz
Post by David Goodger
Post by Suzanne Hillman
Hello everyone!
I'm back again. Again, please cc me on replies. :)
In looking at the substitution definitions
(http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions),
I see that they include images and replacement text. As far as I can tell,
they do not include the possibility of substituting for figures.
Is this accurate?
Yes, by definition. Substitutions are a phrase-level (within text)
"Substitution definitions allow the power and flexibility of
block-level directives to be shared by inline text." Figures are
block-level elements (consisting of an image, and optionally a caption
and/or a legend), and thus cannot occur inside text.
Post by Suzanne Hillman
Do substitutions not yet allow you to substitute for
figures?
Correct, however they won't be added in future. One can't put a figure
inside a sentence.
Post by Suzanne Hillman
I also tried using replace for figures, but it didn't like that.
Only a subset of directives can be used in substitutions: image,
unicode, replace, date.
http://docutils.sourceforge.net/docs/ref/rst/directives.html#directives-for-substitution-definitions
Post by Suzanne Hillman
I couldn't figure out how to add a feature request, if in fact that's not
yet available.
https://sourceforge.net/p/docutils/feature-requests/
If you want to request this as a feature, you'll first have to
demonstrate how it would work. Please show an example of the reST
source, as well as indicate what the result would be.
What do you want to do in your document? Perhaps there's another way.
David Goodger
<http://python.net/~goodger>
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
Docutils-users mailing list
Docutils-***@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/docutils-users

Please use "Reply All" to reply to the list.

Loading...