Enriching the article editor
Hi all,
I already created a ticket, but was encouraged to add an entry to this forum as well, so here goes:
To add more structure to the way we write documentation, I would like the following options to be added to the article editor in Help Center:
1. The option to format text without having to change the HTML code manually.
The following tags are essential to our company:
- p
- h1, h2, h3, ...
- blockquote
- pre / code
Having these formatting options will tremendously improve the ability for technical _and_ non-technical staff to create documentation that is uniform in style.
If you are afraid to make these options available to everybody for some reason, you could add a option that allows you to configure the editor in the help center settings.
Adding these options will also help people out that desire a markdown editor; if it is not possible to write in markdown, at least this will give you the same formatting options that markdown possesses.
2. The option to insert horizontal rules using a HR button
If you want to read more of my motivation, please look at my original ticket: https://support.zendesk.com/hc/en-us/requests/1707419
(off topic) Short tip: For formatting `<pre><code>` blocks I have amended our help center template to include HLJS. It will try to guess the syntax highlighting that should be used and is pretty good at it.
-
Ryan,
Thanks for the update and background. As more companies adopt Zendesk as a CMS solution, you will no doubt keep hearing this request, so glad to see you are working on it.
-
I guess I'm a little confused. My fundamental issue is not that the Zendesk article editor doesn't support the proper HTML code for multi-level bullet points. It's that the way the page is subsequently displayed doesn't conform to HTML standards.
- Here's the way it looks in the Zendesk article editor (snipping from the WYSIWYM editor):
- Here's what the code looks like (from the Zendesk WYSIWYM editor after exposing the html source):
<h3 class="mb">SAP Business One Server running on Microsoft SQL</h3>
<ul>
<li>
SAP B1 Server – Microsoft Windows Server<a href="#_ftn1" name="_ftnref1">[1]</a>
</li>
<ul>
<li>
It is recommended that SAP B1 server be virtualized, hypervisor is your
choice. We have had good success with Windows Hyper-V. One copy of Windows
Server does permit 2 VM licenses.
</li>
<li>
Microsoft SQL Server<a href="#_ftn1" target="_self" name="_ftnref2">[1]</a>
with SQL CAL’s matching the number of SAP B1 users.
<ul>
<li>
SQL maintenance plan should be in place, including backups and
database optimization.
</li>
<li>
SQL Server Collation settings for SAP Business One are quite
specific, please consult the documentation before installing
Microsoft SQL Server.
</li>
<li>- Here's what you get when the page is displayed in zendesk help center:
Here's what you get if you copy/paste that same code into Notepad ++, save the file as .html and open it using chrome:
Our opinion is that this is a deficiency not a product enhancement request. Perhaps we've done something with CSS to override the normal behavior of how help center pages display? However, from where we're sitting, the platform IS NOT displaying what we would consider to be standard HTML code. Code which is already being created by the Zendesk article editor.
Frankly, we're at a loss . . . .
-
I'll ping the product manager to let him know that this conversation continues to be active and that additional feedback is incoming.
To speak to your confusion, you're correct in the guess that CSS overrides the HTML. All formatting of articles in the Help Center is controlled by the theme.
-
Did the knowledge base text editor ever get support for Blockquote!? We do need it as well.
-
Hi Joakim -
No, Blockquote support has not been added to the knowledge base editor.
-
Hi
We would also very much like to allow for small snippets or similar (used for note,warning and other styling) to be able to be added from the toolbar.Did i miss a post or has this been released in Q2 as Ryan McGrew (Product Manager) mentioned 10 months ago ?
"That being said, we are working on a feature to create re-usable pieces of content that can be used in multiple articles in Q2. "We currently ended up highjacking the colors, however this is really not a nice way of doing it.
We also looked into Paligo and Confluence Sync however we would very much prefer to stay in the Zendesk Guide editor.span[class=wysiwyg-color-green130] {
background: #e2ffe4;
color: #1b591f;
text-align: justify;
border-left: 4px solid #00ba0c;
margin: 1.5em 2px;
padding: 0.5em 10px;
display: block;
}
댓글을 남기려면 로그인하세요.
36 댓글