Skip to main content

On Sale: GamesAssetsToolsTabletopComics
Indie game storeFree gamesFun gamesHorror games
Game developmentAssetsComics
SalesBundles
Jobs
TagsGame Engines

Outline processor?

A topic by tryonk created Apr 14, 2023 Views: 229 Replies: 3
Viewing posts 1 to 3
(2 edits)

Hi—new to DeepDwn, geek but not developer (mostly IT support). I heard about Markdown ages ago when I read the original Daring Fireball post but hadn't realized how it had grown over the intervening years. I was reintroduced to it by Ulysses and Speare, because I was looking for apps to help my break down writing into manageable chunks (I'm writing-phobic) and to move from mind maps to text documents. In that vein, I have some questions and/or requests.

DeepDwn seems to be aimed at developers and geeks (I mean, the vim and emacs modes are a bit of a giveaway). Given that, an outline processor may not be the highest priority, but the lovely outline pane seems to cry out for it. That, and the new(ish) Fountain support would seem to be aimed at creatives and Scrivener refugees more than developers.

  • Is there currently a way to rearrange outline sections and their underlying text from the outline pane? This would provide functionality similar to cards in Speare or sheets in Ulysses without stepping too far outside of DeepDwn's existing UI.
  • While I'm at it, I haven't been able to get outline folding to work. Is there a post or page explaining that?
  • Is any form of OPML (outline processor markup language) planned? Many mind map / thought processor apps support that format. I'm not thinking so much of an OPML to Mermaid converter (I'm guessing those exist already) but a way to convert a mind map  into Markdown headings and body text.
  • Is there any facility for attaching non-printing annotations to text? Reference material can easily be created as external files in a folder structure, but I'd like to be able to tag spots in text with comments to myself, bookmarks, etc.

Regardless of whether these features are implemented, I can see DeepDwn being useful in technical documentation, especially since there is (some) Markdown support in ServiceNow (our ticketing system), and I have been writing quite a few knowledge articles. Having a solid, cross platform Markdown editor will be very helpful.

Hello!

Deepdwn began life as a tool for me personally, so it has a number of developer-friendly features, but over time I’ve tried to expand it’s usefulness for writing prose, and improving the UI, etc, to varying degrees of success :)

Is there currently a way to rearrange outline sections and their underlying text from the outline pane?

Not currently. I’ve thought about it some, but I’m not sure it’s a good match for markdown-based outlining, where the outline is based on the header level.

To maintain the tree-like structure, it would need to change the heading level (and possibly later headings as well), or would move (possibly large) sections of text around without changing the header level at all, and I don’t think either of these feel natural in a markdown document.

I haven’t been able to get outline folding to work. Is there a post or page explaining that?

Folding only affects the document view itself, rather than the outline. Here’s the update where it was introduced, which talks about it a bit more: https://billiam.itch.io/deepdwn/devlog/270905/v0250-folding-pinning-file-monitoring-scroll-improvements

a way to convert a mind map into Markdown headings and body text

Not currently planned, as I don’t know how many users would benefit from it. Can you talk about your specific workflow there? Where would your outline come from?

Is there any facility for attaching non-printing annotations to text?

For portability, only what’s available in standard markdown, namely HTML style comments. In Deepdwn, these aren’t rendered in the preview, but there’s some variation in how they’re handled by other systems.

You can select text and press control (or command, on a mac) + forward slash to comment out the selected text in general.

I’m glad you’re finding it useful!

Thought you might be interested in Marked 2–while it’s Mac only (not a problem for me), it provides some of the multi-file and prose oriented tools I was looking for in an app that is designed to work with other editors. It’s also MultiMarkdown rather than git-flavored Markdown, but it seems to recognize most of the Deepdwn example file formatting, sans diagrams, ABC, and the like. I’m just trying it out and will let you know how it works.

https://marked2app.com

kt

(2 edits)

To maintain the tree-like structure, it would need to change the heading level (and possibly later headings as well), or would move (possibly large) sections of text around without changing the header level at all, and I don’t think either of these feel natural in a markdown document.

Yeah—I figured it would be nontrivial to implement. MS does a decent job of it in Word, although very few people know how to use it.

Folding only affects the document view itself, rather than the outline.

Thanks for the tip—I was trying to use the shortcut keys and getting nowhwere. Is that documentation inaccurate, or am I just missing something?

Can you talk about your specific workflow there? Where would your outline come from?

One way of representing a mind map is as an outline, although this misses things like non-hierarchical connections between branches. OPML is a markup language that allows sharing at least the hierarchical organization of a mind map as an outline, between different apps. I can export OPML from MindNode or SimpleMind and read it into Scrivener as a document structure or Word as a multilevel list.

Scrivener is the only app I’ve found that will read OPML and turn it into header levels, which is how most apps I’ve seen implement real document outlines or structures—it’s very similar to an ordered or unordered list, but the formatting and outline processing features are completely different. I’ve searched, and there is no way to move between the two in Word natively—you have to purchase a plugin or add-on for Word or do outboard processing. Since multi-level headings actually allow you to create an overall document structure, TOC, etc., those are what I’m interested in. Lists are helpful, but only within larger portions of text.

I’ve seen posts from others who want to convert from lists to document headings, but programs that actually do this seem to be as rare as hen’s teeth, likely because so few people know that outline processing exists in Word (or other apps), much less how to use it. It also leans heavily on styles, which very people know how to use at all, let alone use well. My design background is that I was the geek in a design studio, and I used styles heavily in Quark Express to make setting lots of text easier and more consistent, as well as easier to change across an entire document by updating the style.

Markdown and HTML 3 and higher explicitly use functional tagging rather than typographical tagging, although you can still tag text as bold and italic rather than strong and emphasized. The advantage to functional tagging is that you are marking how text functions in a document—as a header, caption, or footnote, rather than large and bold or small and italic. If you want to change all the level 2 headers, you just update the style sheet rather than doing a search and replace on all instances of a particular kind of formatting. Good web designers understand this intuitively now, because we’ve been using CSS for so long. Markdown doesn’t care what font face or size or spacing you use for a level 2 header–it’s just a level 2 header, and the style sheet determines how it will look. Changing which style sheet you use can drastically change the look and even structure of a document in just a few clicks, where that would have taken hours or days of work previously. And long documents, like books or bibles, can be formatted with very little human intervention, so long as they are tagged properly. Any website that renders well on a desktop screen and mobile phone relies on this same concept.

Anyway, I suspect this is pretty natural to you, at least if you were born after about 1990—it’s just how things are done now, at least for web formatting. I still see horrible things in Word. It appeals to my geekish sense of order and my love of automating repetitive processes so people can do the fun stuff. I’ve worked in IT in some fashion since the mid-80s with a heavy dose of design in the 90s, and this stuff combines the two. I haven’t worked as a programmer, except simple scripting, so I’m less familiar with how Markdown is used in, say, technical documentation or the ins and outs of git (little geek humor there).

Do that all make sense?

kt