Single-topic editor that contributors can use free?

Nothing is perfect! This is where you can post your ideas and wishes for functions you'd like to see in Help & Manual. Current version only please (H&M7).

Moderators: Alexander Halser, Tim Green

Post Reply
Simon_Dismore
Posts: 205
Joined: Thu Jul 13, 2017 2:57 pm

Single-topic editor that contributors can use free?

Unread post by Simon_Dismore »

Not so much a wish-list, more a question...

There's interest in implementing Markdown import and improving RTF conversion in H+M, to incorporate material from outside sources. One of the use cases is subject-matter experts creating new/updating existing topics. That is, the import isn't from a legacy repository, it's part of an ongoing authoring workflow.

For that scenario, why not create a free-of-charge version of H+M for authors, that can create/edit TinyXML files, import RTF/Markdown to a single topic, add pictures and media links, check spelling, apply existing styles, but:
  • Can't create new projects, styles, variables, templates;
  • Can't manage the TOC (not sure if there should even be a TOC visible);
  • Can't update styles or apply inline formatting (except B, I, U perhaps?);
  • Can't change the project configuration;
  • Can't publish to output formats (except maybe a basic print-preview sort of PDF for proofing?).
The idea is that instead of having to do cumbersome conversion from foreign formats, the documentation team receives contributions that are already in exactly the right form for importing. They can send out topic files for authors to review or update and be sure that only the content will have changed, not the formatting. Maybe that will even get some authors enthusiastic about having a full version of H+M.

Thoughts?
User avatar
Tim Green
Site Admin
Posts: 23156
Joined: Mon Jun 24, 2002 9:11 am
Location: Bruehl, Germany
Contact:

Re: Single-topic editor that contributors can use free?

Unread post by Tim Green »

Hi Simon,

We've discussed the possibility of an editor like that a couple of times but there are a number of drawbacks. It would soon become a feature request magnet that would grow inexorably with time and its parallel development and maintenance would consume a large and possibly growing amount of development resources that would be better employed elsewhere. We're also unsure whether there are really that many contributors who would really use it. Experience in support indicates that external contributors generally use Word and Word only, and getting them to use something else would be difficult -- at least in numbers large enough to warrant such a development.

That doesn't mean that something like this isn't on the consideration list in the long term, but there are a number of issues that need to be resolved before diving into it.
Regards,
Tim (EC Software Documentation & User Support)

Private support:
Please do not email or PM me with private support requests -- post to the forum directly.
Simon_Dismore
Posts: 205
Joined: Thu Jul 13, 2017 2:57 pm

Re: Single-topic editor that contributors can use free?

Unread post by Simon_Dismore »

Tim Green wrote:[that] would soon become a feature request magnet that would grow inexorably with time and its parallel development and maintenance would consume a large and possibly growing amount of development resources that would be better employed elsewhere.
Thanks for feedback. On reflection of course it would be counter-productive to have a special version. How about sticking with a single set of binary files, but add an unlicensed mode of H+M that has some features disabled so the user can't create or publish projects, topics, templates, styles etc?

Things to disable might be:
  • Almost everything on File, except Open, Save, Save As, Recent Projects and Exit
  • If the project is in version control the connection can't be edited
  • Almost everything on Project ribbon, except spelling checker
  • Write > Font group except B, I, U, super/subscript, code editor, count words
  • Write > Paragraph group except B, I, U, super/subscript, code editor, count words
  • Disable style creation/modification
  • View > Program options, reset defaults
  • Ability to modify the TOC is disabled (can't move topics, popup menu disables everything except Explore and Find referrers)
  • The Topic Options and XML tabs, and the Settings button are disabled
  • In Project Explorer the Project Files and Configuration buttons are disabled
  • Shortcuts that have the same effects as above
The way of working could be:
  • documentation is coordinated by writer(s) using H+M Pro
  • default for all topics is that they are locked and can't be edited by unlicensed copies of H+M
  • coordinator specifically unlocks topics that unlicensed contributors are permitted to change
  • the coordinator must create and unlock an empty 'stub' for each new topic required
  • contributors can work on project just like real licensed writers (via version control if necessary)
If you like the idea in principle, this might be a relatively straightforward way to achieve it.
Post Reply