To main heading

Smallsite Design

Online editing help

Spikes

While using the simple text cutting and pasting available in most operating systems is useful for plain text, spikes provide the ability to move complex elements around an article or between articles.

The advantages of spikes over normal cut-and-paste are:

  1. a.The cloned elements are visible in the spike list.
  2. b.Spikes can store multiple items.
  3. c.Spikes can have other items added to them.
  4. d.Some elements can be unwrapped to a spike, where its sub-elements can be individually actioned.

While the spikes allow a lot of flexibility, the To facility is faster for many simple move operations.

Performing any of these operations can break links as sections, subsections or glossary entries are moved around. After all changes are done, click the F5 key to find where ʘ?ʘs occur on the page. Each such link will show their current target fragment, which should partially match one from their list of current article fragments, which should then be selected.

Spike operations

Using a spike is much like using copy and paste, except that the complexity of elements makes it a little more involved.

The basic spike operations are:
#OperationDescription
aAddBy clicking on the spike to add to under an element's Actions cell, usually represented like 1|0, being the spike number with the number of items already on it
bAppendAdd the spike item after the last child of the selected element
cInsertInsert the spike item after the currently selected element
dReplaceReplace the currently selected element with the spike item. Requires confirmation because the current selection contents are overwritten

Append and Insert function exactly as for an element, but using the selected spike item rather than an empty element. The flexibility of these operations is enhanced when used as substitutions.

Adding to a spike copies the element to the spike, but pasting moves the element from the spike. This ensures that there is always a copy of the element in the article while spike operations are being undertaken. Unwanted elements can be deleted after any use of the spikes is complete. If wanting to paste multiple copies of the same element from a spike, add it to the spike as often as needed.

Per user

Spikes are owned by a user, but they are only available for specific uses, and deleted afterwards.

There are three spikes, with each normally holding up to nine items. An item is a complete element with all its children. All three spikes can be used within the latest version of the document being edited. However, spike 3 can also be used to collect items from previous versions or from other documents. If intending to copy from other than the latest version, focus on using spikes 1 and 2 for the latest version.

The items from the current article that are placed on spikes will be deleted when the current editing is complete because access to the current article is discontinued so it makes sense to cease access to any material from it.

When other articles are specified as sources for the current article, any items placed on spikes from them will be deleted when access to those source articles is finished, typically along with the end of current editing of the current article. However, if any spike items are from source articles for other articles still being edited by a user, those will remain on their spikes.

Block elements can only be put on spikes when in the master locale, in line with that the article structure can only be modified there. However, inline elements can be moved around in any locale to cater for the different grammatical renderings of each.

Substitutions

Many elements have the same internal structure but are known by other names. Some of these can be substituted for each other when moving off a spike.

Paragraphs, introductions, list items and table cells are all what is called rich-text in that they can contain a variety of inline elements for formatting text. Without substitutions, all the inline text elements would have to be copied into a new element having a different name. When moving from a spike with substitutions, the outer element is renamed while leaving its internal structure intact.

A glossary item is a rich-text element with a Heading. When it is used as a substitute, that Heading will be stripped off. Conversely, substituting something else for a glossary item, a Heading in need of text will be added.

A sample table cell spike item when the article element is selected is:
Sample table cell spike item for article

Here, the table cell can only be appended to the article as a paragraph.

The extra options for the same spike item when a paragraph is selected are:
Sample table cell spike item for paragraph

With a paragraph selected, there are more opportunities for substitutions, being:

  1. a.Append the table cell to the paragraph as a footnote.
  2. b.Insert the table cell as a paragraph after the selected paragraph.
  3. c.Replace the selected paragraph with the table cell as a paragraph, requiring a confirmation because the current paragraph is overwritten.

Under Details, if the item is from another article, that article's ID is shown underneath the other details.

A simple scenario for using a spike is when having started a paragraph with some formatting, it may be better to use it as an introduction to a list. That can be done by:

  1. 1.Saving the paragraph to a spike.
  2. 2.Inserting a list after the paragraph.
  3. 3.Selecting the list's empty introduction.
  4. 4.Clicking Replace Introduction for the spike item with the paragraph.
  5. 5.Deleting the original paragraph.

The elements that are altered when used as substitutes are:

  1. a.Glossary items lose their Headings.
  2. b.Resulting glossary items are given an empty Heading.
  3. c.Sections lose their subsections. Perhaps Unwrap the section to store its subsections on spike 3.
  4. d.Rich-text elements lose their footnotes if not allowed in target.

What isn't automatically done is to delete final full stops when substituted as an introduction because it has a colon placed at its end, or adding a full stop when substituted as a standalone rich-text element like a paragraph. There can be valid reasons for having the text of an introduction having a full stop before the colon, such as some acronyms.

Not at end of rich-text

In general, leave final full stops off rich-text elements,
as they will be appended as required when their page is viewed.

Unwrapping

Rather than placing all the children of an element on a spike one at a time, some elements allow all their children to be put on a spike at the same time.

Normally a spike can only hold up to nine items, but if spike 3 is empty and the parent element allows it, all children can be deposited on the spike at once, regardless of how many children there are.

In general, most elements can be unwrapped, including whole articles. Some of the elements unwrapped may only be able to replace the same element type in another article of the same type. For example, the items of a policies article section can only replace items in another policies article. Some children, such as table rows, would be problematic to append or insert, so the parent cannot be unwrapped.

Scratchpad

If wanting to restructure a full group of children for an element, the spikes can be used as content scratchpads.

Articles, such as procedures and tests, allow a few introductory blocks, just so that they don't over-shadow the main purpose of the article type. If the limit is reached, the only way to be able to add anything is to delete some blocks, or restructure the content by using the spikes as a temporary holding bay to substitute those elements into a new structural block. Of course, the originals of what is cloned to the spike needs to be deleted from the host element to make space for the new structural blocks, be they a list or a table.

For example, restructuring a few paragraphs into a list involves:

  1. a.Saving all the paragraphs involved to a spike, or unwrapping the host element and deleting what is not required from the spike.
  2. b.Deleting those same paragraphs from the host element itself, freeing up space for more blocks.
  3. c.Inserting a list element.
  4. d.Replace the two empty items on the list with two paragraphs from the spike.
  5. e.Insert the remaining paragraphs on the spike as items after each other.
  6. f.Add text to the list's introduction.
  7. g.Clone items to be split, and edit each item to suit.

A table would be similar, except that it would have to be fully constructed, and then the paragraphs substituted for the cells where their content is to go.

Limitations

While spikes can be fairly flexible, there are still limits to what can be done.

Some things to consider are:

  1. a.For plain text, copy-and-paste may be faster and require less keystrokes.
  2. b.Some elements are too problematic to paste from a spike, so are not allowed. For example, spiking a table row would require being able to specify which cells to delete if more than in the target table, or which cells in the target to put each cell if less than the target.

To

To quickly move certain block elements to another block that can parent them, the To facility is provided.

The To option is found in the Actions cell of those elements that can be moved using it. Checking the box will display the table of available parent elements to move the current element to. Click the Target column jump for the required new parent element and the current element will be appended to it. This can make operations like moving a paragraph to a section much faster and more straightforward than using a spike.

If the target parent is manually disabled, its name in the Target column will have a strike through it. If the target is disabled due to errors in it, the row will have a thicker red outline and a light orange background.

The limitations of the To facility are:

  1. a.Only available for block elements that can be moved to available parent elements that allow it.
  2. b.Only for moving, not copying.
  3. c.Not available where moving the element would make its current or target parent have an invalid number of children.
  4. d.Not available where the element has the same id attribute as a child of the intended target. Only relevant for elements with Headings like glossary entries or sections.
  5. e.Only appended to the new parent element. Use the move buttons to place it in the required position.
  6. f.Only available for movements within the current version.
  7. g.No substitutions or unwrapping that spikes allow.

A typical scenario for this is when editing a large monolithic article to use sections. After creating a section, each paragraph to go into it can be appended to it using the paragraph's To table. Of course, a paragraph can also be moved to an aside, block quote, or any other element that allows it.

  • Element block
  • Article body
  • Contact   Glossary   Policies
  • Categories   Feed   Site map

  • This site doesn't store cookies or other files on your device when visiting public pages.
    External sites: Open in a new tab or window, and might store cookies or other files on your device. Visit them at your own risk.
    Powered by: Smallsite Design©Patanjali Sokaris