TitleTerminate numbered lists at blank line instead of a non-list line.
Date23-Oct-2007 21:46:48 EEST
JSPWiki version2.4.102
SubmitterRaganHaggard
Idea CategoryMarkupIdea
Referencehttps://www.opends.org/wiki//page/QuickAndDirtySSLSetup
Idea StatusNewIdea

We use numbered lists to document procedures, but some procedures have multiple paragraphs. Because numbered lists stop when they encounter a non-list line, we end up numbering our steps by hand and settling for subordinate paragraphs that are fully left-indented. We expect that our kludge will be a greater problem when we produce a hard copy from our wiki.

The procedure at https://www.opends.org/wiki//page/QuickAndDirtySSLSetup shows an example. Step one includes both a multi-line code block and a subordinate paragraph. We could mock up the code block and jam all paragraphs into a single line using back slashes for line breaks, but that's not a friendly solution for the people we hope will contribute to our wiki and we still wouldn't get the indentation that we seek. Plus, we like to use code blocks for readability and our ease-of-use

Our hoped-for solution is for JSPWiki to terminate a numbered list when it encounters a blank line. I can't offer a sample page, but I have seen non-public pages that achieve this using Confluence. The following example wikitext shows how I would expect to recast the example steps 1 and 2 if this new idea were implemented, but since it contains code blocks it doesn't resolve well on the screen and you have to edit this page to see what I mean:

  1. Create a private key for the certificate with the command:

$ keytool -genkey -alias server-cert -keyalg rsa \
  -dname "CN=dogmatic.central.sun.com,O=Sun Microsystems,C=US" \
  -keystore config/keystore -storetype JKS

In this case, the value of the "-dname" argument should be changed so that it is suitable for your environment. The value of the CN attribute should be the fully-qualified name of the system on which the certificate is being installed, the value of the O attribute should be the name of the company or organization, and C should be the two-character country abbreviation. You will be interactively prompted for both a password to protect the contents of the keystore and a password to protect the private key. Both passwords should be the same.
  1. Generate a self-signed certificate for the key with the command:

$ keytool -selfcert -alias server-cert -validity 1825 \
  -keystore config/keystore -storetype JKS

When you are prompted for the keystore password, enter the same password that you provided for the previous command.

Have you thought about using the [Counter]] instead? It has the added advantage that you can have several paragraphs: Your example would look like this (edit the page):

1. Create a private key for the certificate with the command:

$ keytool -genkey -alias server-cert -keyalg rsa \
  -dname "CN=dogmatic.central.sun.com,O=Sun Microsystems,C=US" \
  -keystore config/keystore -storetype JKS

In this case, the value of the "-dname" argument should be changed so that it is suitable for your environment. The value of the CN attribute should be the fully-qualified name of the system on which the certificate is being installed, the value of the O attribute should be the name of the company or organization, and C should be the two-character country abbreviation. You will be interactively prompted for both a password to protect the contents of the keystore and a password to protect the private key. Both passwords should be the same.

2. Generate a self-signed certificate for the key with the command:

$ keytool -selfcert -alias server-cert -validity 1825 \
  -keystore config/keystore -storetype JKS

When you are prompted for the keystore password, enter the same password that you provided for the previous command.

For added credit, you can define a "procedure" style in your local CSS:

.procedure {
   margin-left: 10px;
}

and then use it to wrap your procedure lists with %%procedure.

-- JanneJalkanen


Thanks, I wasn't aware of [Counter] and didn't think of setting up a specific style. Those are good solutions for dedicated writers, but we're hoping to cater to our community contributers by letting them use plain wikitext (which can be difficult enough as it is).

-- RaganHaggard

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-5) was last changed on 24-Oct-2007 00:28 by RaganHaggard