Assist Editing Guide - Revision history

Anw: Minor update

2026-02-20T11:23:54Z

Minor update

Anw: Updated

2025-07-22T13:33:30Z

Updated

Show changes

Anw: Interwiki

2025-07-22T13:08:45Z

Interwiki

@@ Line 258: / Line 258: @@
 Some simple templates:
 ** Note - This provides a note graphic {{Note}}like so
-** Warning - This provides a warning graphic  {{Warning|like so}}
+** Warning - This provides a warning graphic  {{Warning}}like so
 ** Xref - this provides a cross-reference in a standard format. Use it like so: <nowiki>{{Xref|Type=Image|Num=1|Text=An image of something}}</nowiki>
 ** Incomplete - this adds a warning that the document is incomplete, and adds the document to an Incomplete category, so it can be easily found and completed. Use it like so: <nowiki>{{Incomplete}}</nowiki>
-* Generic glossaries have been provided for the ''CALIDUS'' products. These can be added to if required by clicking on the glossary template in the editing screen.
+* Generic glossaries have been provided for the ''CALIDUS'' products -
 * Test Plan templates are available to construct test plan cycles - see the Functional Specification template for details on how these work.
 * A Comment template has been added to identify comments added to a reviewed document easily {{comment|text=like so
@@ Line 291: / Line 295: @@
 The system will copy everything required in the template into a brand new page created for you, so that you can complete editing it.
@@ Line 369: / Line 439: @@
 Pages that have been added to categories will be shown in the ''Categories'' section of the toolbar - clicking these links will take you to all pages in that category.

Anw: Updated to show how to update an existing image.

2025-06-05T10:44:52Z

Updated to show how to update an existing image.

← Older revision		Revision as of 12:44, 5 June 2025
Line 131:		Line 131:

	{{Warning}} Unfortunately, you can't (yet) add searchable tables through the visual editor. Worse, the visual editor may remove your searchable tables code when saving the page, so a bit of a downside.		{{Warning}} Unfortunately, you can't (yet) add searchable tables through the visual editor. Worse, the visual editor may remove your searchable tables code when saving the page, so a bit of a downside.





	Images are covered in a following section.		Images are covered in a following section.



Line 150:		Line 154:

	{{Warning}} Bear in mind that, with either Source or Visual editing, you can't trim or edit the image when it's uploaded, so make sure what you're uploading is what you want to see in the final document.		{{Warning}} Bear in mind that, with either Source or Visual editing, you can't trim or edit the image when it's uploaded, so make sure what you're uploading is what you want to see in the final document.



Line 171:		Line 176:
	You have an '''Upload''' button here, so you can upload the image you have already saved to your PC.		You have an '''Upload''' button here, so you can upload the image you have already saved to your PC.

			When visual editing, you have lots of options to create a new image.
	When visual editing, you have lots of options.
	* You can take a screenshot of a window or copy an image from a document or filesystem, then just paste (<code>CTRL-V</code>) in the editor - the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, then edit any properties. Steps:		* You can take a screenshot of a window or copy an image from a document or filesystem, then just paste (<code>CTRL-V</code>) in the editor - the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, then edit any properties. Steps:
	** Paste the image - the image popup will appear.		** Paste the image - the image popup will appear.
Line 192:		Line 196:

	Then you can insert the image.		Then you can insert the image.

			For updating an image that already exists, however, your options are more limited. It's important that we update images, rather than upload new ones. If you attempt to paste in an image and call it the same thing as something that already exists, Visual Editor will throw an error.

			To update the image, you have to save as a picture file first:

			* From a Word document, right-click, Save as Picture, give it a name and save.
			* From printscreen, paste into your paint application and save as PNG.
			* From Snip and Sketch, save as PNG.

			You can then:

			* click on the image link and upload a new version from the upload page.
			* click ''Upload File'' from the Wiki Tools toolbar on the left and upload a new copy.
			* batch upload the file - see below for details.

Anw: WikiEditor additional buttons

2024-09-06T13:40:41Z

WikiEditor additional buttons

← Older revision		Revision as of 15:40, 6 September 2024
Line 33:		Line 33:
	* <sup>Superscript text</sup> or <sub>Subscript text</sub>		* <sup>Superscript text</sup> or <sub>Subscript text</sub>
	* Links to other pages, like [[Did You Know]].		* Links to other pages, like [[Did You Know]].
			* <code>Code</code>.
			* "Noinclude" tags.

	You can also highlight the text you want to format and then click the button - the editor will tag the text you highlighted.		You can also highlight the text you want to format and then click the button - the editor will tag the text you highlighted.

Anw: Updated

2024-09-06T10:50:29Z

Updated

← Older revision		Revision as of 12:50, 6 September 2024
Line 90:		Line 90:
	* <big>Big text</big> or <small>Small text</small>		* <big>Big text</big> or <small>Small text</small>
	* <sup>Superscript text</sup> or <sub>Subscript text</sub>		* <sup>Superscript text</sup> or <sub>Subscript text</sub>
			* <code>Computer code formatting</code>

	and many more.		and many more.
Line 105:		Line 106:
	Paragraph formatting can be accessed from the '''Paragraph Formatting''' drop-down list in the toolbar.		Paragraph formatting can be accessed from the '''Paragraph Formatting''' drop-down list in the toolbar.
	* Headings (level 2-5)		* Headings (level 2-5)
	* Code formatting		* Preformatted Code formatting
	* Centre text		* Centre text

Anw: Updated

2024-09-06T10:46:51Z

Updated

← Older revision		Revision as of 12:46, 6 September 2024
Line 78:		Line 78:

	{{Note}} The visual editor can use keyboard shortcuts, and the editor will tell you the shortcut keys next to the toolbar option you are selecting, if there is one.		{{Note}} The visual editor can use keyboard shortcuts, and the editor will tell you the shortcut keys next to the toolbar option you are selecting, if there is one.

			Standard shortcut keys are also supported, like cut/copy/paste:
			* <code>CTRL-X</code> - Cut.
			* <code>CTRL-C</code> - Copy.
			* <code>CTRL-V</code> - Paste (formatted).
			* <code>CTRL-SHIFT-V</code> - Paste (plain text).


	The same is true for:		The same is true for:

Anw: Expanded on Images in Visual Editor

2024-09-06T09:36:00Z

Expanded on Images in Visual Editor

← Older revision		Revision as of 11:36, 6 September 2024
Line 163:		Line 163:

	When visual editing, you have lots of options.		When visual editing, you have lots of options.
	* You can take a screenshot of a window or copy an image from a document or filesystem, then just paste (<code>CTRL-V</code>) in the editor - the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, then edit any properties.		* You can take a screenshot of a window or copy an image from a document or filesystem, then just paste (<code>CTRL-V</code>) in the editor - the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, then edit any properties. Steps:
	* You can drag and drop a local image from your PC straight to the window. When you drop it, the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image, ~~then edit any~~ properties.		** Paste the image - the image popup will appear.
	* You can choose images you have recently uploaded by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab and then amend the properties.		** The image will initially be named "image.png" - that's OK, as we will change it in a minute - Check "This is my own work" and then click '''Upload'''.
			** Enter a name - make sure that this is unique and relevant, , like "VEhub_Login.png" or "Tesla Order Search 1.png".
			** Enter a description - the dialogue forces you to enter a description - I suggest just copying in the filename.
			** Click '''Save''' - the properties box will be displayed - see below..
			* You can drag and drop a local image from your PC straight to the window. When you drop it, the ''Image'' dialogue will appear, showing a thumbnail, allowing you to name the image (which will default to the name of the file being uploaded). From that point, it's similar to the above process, of uploading, naming, saving and editing properties.
			* You can choose images you have recently uploaded by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab, select it, click '''Use this image''' and then amend the properties. This is super-useful when combined with batch uploading of images (below).
			* You can choose to re-use images that have already been uploaded onto the Assist by anyone - select the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then search for images by their name from the ''Search'' tab. When you find an appropriate image, you can select it, click '''Use this image''' and then amend the properties.
	* You can directly upload a saved image by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab and then amend the properties.		* You can directly upload a saved image by selecting the '''Insert''' button on the toolbar and selecting ''Images and Media''. You can then select the image from the ''Search'' tab and then amend the properties.

Line 171:		Line 177:
	* ''Caption'': optional		* ''Caption'': optional
	* ''Alternative text'': optional		* ''Alternative text'': optional
	* ''Position'': Left, Center, Right or None.		* ''Position'': Left, Center, Right or None. Choose Center or None. If will turn itself off if you select a Basic image.
	* ''Image Type'': Choose ~~None~~.		* ''Image Type'': Choose Basic.
	* ''Image Size'': optional, but any image that you ware uploading that is greater than 1000px wide should be reduced to that or 800px, to make them fit in the PDF when produced.		* ''Image Size'': optional, but any image that you ware uploading that is greater than 1000px wide should be reduced to that or 800px, to make them fit in the PDF when produced.

Line 178:		Line 184:


	Regardless of which editor you are are using, you also have the ability to batch upload images. So, if you have created all the images you need and named them appropriately, you can upload those images using the Special page "''Upload Multiple Files''". From there, you can drag and drop all of your images into the system, then use them in your page.		Regardless of which editor you are are using, you also have the ability to batch upload images. So, if you have created all the images you need and named them appropriately, you can upload those images using the Special page "''Upload Multiple Files''". From there, you can drag and drop or multi-select all of your images into the system, then use them in your page.

			* Save your images to local files in a unique and reasonable filename - if it's reusable for other things, make them relevant, as above.
			** From a Word document, right-click, Save as Picture, give it a name and save.
			** From printscreen, paste into your paint application and save as PNG.
			** From Snip and Sketch, save as PNG.
			* Go to the Assist Special pages
			* Select ''Upload Multiple Files''
			* Enter a description if you want - it's optional, but can be useful. For example, if uploading a load of images relating to a Tesla Support document, you might enter "Tesla Support Images". But you can also leave this blank - that's perfectly fine.
			* Either
			** Select all your images in a Windows explorer and drag and drop to the appropriate place on the page
			** Click the button, multi-select from the popup explorer and confirm.
			* The files you selected will be shown in a list on the page.
			* As they are uploaded, they will change colour to show whether they uploaded successfully or not
			** If they turn green, all good.
			** If they turn red, they didn't upload - check the error reason and correct.
			* {{Warning}}Uploading a file that already exists will create a new version of that file - you should check where this image has been used before and make sure that the image you have uploaded is appropriate to all pages that use it.

	== Templates ==		== Templates ==

Anw: Anw moved page Help:EditOBS to Assist Editing Guide

2024-09-03T16:52:40Z

Anw moved page Help:EditOBS to Assist Editing Guide

← Older revision	Revision as of 18:52, 3 September 2024
(No difference)

Anw: Updated

2024-09-03T16:49:04Z

Updated

Show changes

← Older revision		Revision as of 13:23, 20 February 2026
Line 5:		Line 5:
	==Document Editing==		==Document Editing==
	When you find a page that needs editing, you can do it in one of to ways:		When you find a page that needs editing, you can do it in one of to ways:
	* Source Editing - typing in plain text with WikiText markup language - not too complicated, but a bit of a barrier for new users. Click the ''Edit Source'' button to start source editing.		* Source Editing - typing in plain text with WikiText markup language - not too complicated, but a bit of a barrier for new users. Click the ''Edit Source'' button to start source editing. {{Note}}Source editing is stored in the browser, but will not persist of you close the browser. That makes it easy to lose a lot of changes if you are editing in source editor. Visual Editor changes will persist - it will remember your last changes in the session (as long as the session is still there!). So it's a lot harder to lose your changes between sessions with Visual Editor (as well as being a lot easier to use). You should only use Source Editing for certain things (like manually making small changes, adding "noinclude" tags, making a table searchable, etc - these exceptions are all called out below.
	* Visual Editing - like a simple version of your favourite document editing application. You can do most things (but not all) with Visual Editing. Click the ''Edit'' link against a page to start Visual Editing.		* Visual Editing - like a simple version of your favourite document editing application. You can do most things (but not all) with Visual Editing. Click the ''Edit'' link against a page to start Visual Editing.

Line 59:		Line 59:
	Then you can edit it. We typically do not use captions, so you could remove that line if you want. To change the cell content, simply change the text between the vertical bars (or exclamation points, if it's the header row).		Then you can edit it. We typically do not use captions, so you could remove that line if you want. To change the cell content, simply change the text between the vertical bars (or exclamation points, if it's the header row).

	Tables also support being searchable - it's not a property that is supported by the Table tool, so you have to edit it in yourself.		Tables also support being searchable - it's not a property that is supported by the Table tool, so you have to edit it in yourself using the source editor.
	* Add "apt-searchable" to the table class		* Add "apt-searchable" to the table class
	<nowiki> {\| class="wikitable apt-searchable" </nowiki>		<nowiki> {\| class="wikitable apt-searchable" </nowiki>
Line 131:		Line 131:
	Editing the contents of the table is directly in the cells themselves - much easier.		Editing the contents of the table is directly in the cells themselves - much easier.

	{{Warning}} Unfortunately, you can't (yet) add searchable tables through the visual editor. ~~Worse, the visual editor may remove your searchable tables code when saving the page, so a bit of a downside~~.		{{Warning}} Unfortunately, you can't (yet) add searchable tables through the visual editor. You should switch to source editing to add this functionality.





	Images are covered in a following section.		Images are covered in a following section.



	== Standards ==		== Standards ==