Assist - General Usage - Revision history

Anw: Added preferences

2026-02-25T10:07:47Z

Added preferences

@@ Line 115: / Line 115: @@
 You should change your user page within Assist to list your contact details (email and phone number) so that other users can easily contact you.
 == Reading ==
@@ Line 193: / Line 226: @@
 You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages|special pages]].
-{{Note}} Category editing is a
+{{Note}} Category editing is a <span style="color: black; text-shadow: 0 0 2px red, 0 0 10px #600; font: 900 2rem serif; ">DARK ART</span> but necessary - see the [[Assist Editing Guide]] for more details.
 == Image Repository ==

Anw: Minor formatting change

2026-02-25T09:14:08Z

Minor formatting change

← Older revision		Revision as of 11:14, 25 February 2026
Line 192:		Line 192:

	You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages\|special pages]].		You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages\|special pages]].

			{{Note}} Category editing is a
			<span style="color: black; text-shadow: 0 0 2px red, 0 0 10px #600; font: 900 2rem serif; ">DARK ART</span> but necessary.

	== Image Repository ==		== Image Repository ==

Anw: Minor formatting changes

2025-07-14T13:51:15Z

Minor formatting changes

← Older revision		Revision as of 15:51, 14 July 2025
Line 67:		Line 67:
	** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups		** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups

	Note thar all extensions mentioned above are properly attributed to their authors, visible through the Assist's special page "Special:Version"		Note thar all extensions mentioned above are properly attributed to their authors, visible through the Assist's special page "Special:Version". See section [[Assist - General Usage#Special Pages\|Special Pages]] below.

	== Accessing the Systems ==		== Accessing the Systems ==
Line 157:		Line 157:
	A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.		A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.

	On top of the table will be a ~~search~~ box. Type in what you're looking for and the table will be filtered to show all of the matching rows - that is, rows where any column contains that text at all, anywhere. This filters as you type.		On top of the table will be a ''Search'' entry box. Type in what you're looking for and the table will be filtered to show all of the matching rows - that is, rows where any column contains that text at all, anywhere. This filters as you type.

	Note that some data will be always be shown, like headers, or rows that the writers of the page have decided must always be shown.		Note that some data will be always be shown, like headers, or rows that the writers of the page have decided must always be shown.

	You can clear the text out of the ~~search~~ box and this will display everything again - do this by either deleting it or use the provided clear button to the right of the ~~search~~ box.		You can clear the text out of the ''Search'' box and this will display everything again - do this by either deleting it or use the provided clear ('''X''') button to the right of the ''Search'' box.

	Have a go below - maybe try entering "ap", then "app", or enter "fruit" and see the way it works.		Have a go below - maybe try entering "ap", then "app", or enter "fruit" and see the way it works.
Line 191:		Line 191:
	From a page, you can see categories in the Categories list and click on them to see all pages in that category.		From a page, you can see categories in the Categories list and click on them to see all pages in that category.

	You can also see all categories from the Categories or Category Tree special pages.		You can also see all categories from the Categories or Category Tree [[Assist - General Usage#Special Pages\|special pages]].

	== Image Repository ==		== Image Repository ==
Line 214:		Line 214:

	== Special Pages ==		== Special Pages ==
	You can access a lot of special pages from the Wiki Tools/Special Pages menu. Of interest are:		You can access a lot of special pages from the ''Wiki Tools/Special Pages'' menu. Of interest are:

	* Lists of pages		* Lists of pages

Anw: Updated

2025-07-14T13:45:03Z

Updated

← Older revision		Revision as of 15:45, 14 July 2025
Line 6:		Line 6:

	Each Assist instance contains information, guides, documents and FAQs on the product for which it is intended, plus links to any other product Assist instances that may be relevant.		Each Assist instance contains information, guides, documents and FAQs on the product for which it is intended, plus links to any other product Assist instances that may be relevant.

			Assist is '''product''' documentation and guides, as opposed to specific customer usage guides. All customer-specific functionality has been referenced and documented as part of the product. Customer-specific Usage guides are generally the responsibility of the customer to produce, based on the provided product documentation and the solution design document and Statement of Work.

			Should any customer wish for their specific documentation to be hosted within Assist, Aptean will review on a case-by-case basis and add as appropriate, so long as specific permission is given for this documentation to be available for all customers.

			At this moment, no customer-specific instances of Calidus Assist exist.



Line 22:		Line 29:
	* Reusable screen shots and screen descriptions.		* Reusable screen shots and screen descriptions.
	* Categorization of pages together, both for navigation purposes and producing documents from the categories.		* Categorization of pages together, both for navigation purposes and producing documents from the categories.
	* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write ~~all~~" sensibilities and reduces duplication of effort.		* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write everywhere" sensibilities and reduces duplication of effort and increases the likelihood that all pages are up to date with the latest functionality.
	* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.		* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.
	* Assistance creating new pages using templates		* Assistance creating new pages using templates
Line 60:		Line 67:
	** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups		** "Peek" at linked pages by hovering over the link. Incudes an appropriate thumbnail picture if there is one - through Extension:Popups

			Note thar all extensions mentioned above are properly attributed to their authors, visible through the Assist's special page "Special:Version"

	== Accessing the Systems ==		== Accessing the Systems ==
Line 90:		Line 97:
	** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS		** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS

	You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:<center>[[File:ASSIST-UI-PC.png\|800x800px]]</center>		You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:<center>[[File:ASSIST-UI-PC.png\|none\|thumb\|800x800px\|Browser UI]]</center>

	<center>[[File:ASSIST-UI-Tab-Landscape.png\|none\|thumb\|800x800px\|Assist UI Tablet Landscape]]</center>		<center>[[File:ASSIST-UI-Tab-Landscape.png\|none\|thumb\|800x800px\|Assist UI Tablet Landscape]]</center>
Line 103:		Line 110:
	You don't need to log in to view pages on Assist, only if you want to edit them.		You don't need to log in to view pages on Assist, only if you want to edit them.

	If you do, click the Anonymous drop-down on the title, where you have the option to log in.		If you do, click the ''Anonymous'' drop-down on the title, where you have the option to log in.

	If you've forgotten your password, you can reset it here using your username or your email - this will only work if your email is associated to your user.		If you've forgotten your password, you can reset it here using your username or your email - this will only work if your email is associated to your user.
Line 232:		Line 239:

	== Translation ==		== Translation ==
	~~The~~ toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.		Aptean do not maintain translated Assist help pages. However, the toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.

			You can remove the translation by closing the Translate toolbar at the top of the screen.

	== Printing and Exporting ==		== Printing and Exporting ==

Anw: History and Image Repository

2025-06-20T13:13:45Z

History and Image Repository

← Older revision		Revision as of 15:13, 20 June 2025
Line 15:		Line 15:
	* Ability to download any guide in Aptean formatted PDF document.		* Ability to download any guide in Aptean formatted PDF document.
	* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).		* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).
			* Historical access to previous versions of pages and images.
			* Image repository - View and download any file.

	Internally, Assist also provides:		Internally, Assist also provides:
Line 183:		Line 185:

	You can also see all categories from the Categories or Category Tree special pages.		You can also see all categories from the Categories or Category Tree special pages.

			== Image Repository ==
			The Wiki acts as an image repository for all. This is especially useful to sales teams both internal and external, as images can be clicked, zoomed in and downloaded for your own use.

			== Historical Version Access ==
			Wikis always keep a history of all changes made to a page, along with a commentary as to why this change was made. You can access this with the History tool. This allows you to see previous versions, check the authors, query with the correct people, etc, which ensures much more accurate documentation.

			Note that you can also access historical versions of images when clicking the image. You can view and download these historical versions.

	== Seeing Links ==		== Seeing Links ==
Line 193:		Line 203:

	You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).		You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).

			You can see both what links from and to, in transcluded by and transcludes this page and the history of changes to each of the related pages by using the ''Related Changes'' tool.

	== Special Pages ==		== Special Pages ==

Anw: Minor formatting change

2025-06-20T12:56:03Z

Minor formatting change

← Older revision		Revision as of 14:56, 20 June 2025
Line 88:		Line 88:
	** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS		** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS

	You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:		You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:<center>[[File:ASSIST-UI-PC.png\|800x800px]]</center>

	~~[[File:ASSIST-UI-PC.png\|800x800px]]~~		<center>[[File:ASSIST-UI-Tab-Landscape.png\|none\|thumb\|800x800px\|Assist UI Tablet Landscape]]</center>
	[[File:ASSIST-UI-Tab-Landscape.png\|none\|thumb\|800x800px\|Assist UI Tablet Landscape]]
	<gallery widths="260" heights="600" perrow="3">		<center><gallery widths="260" heights="600" perrow="3">
	File:ASSIST-UI-Tab-Portrait.png\|Assist UI Tablet Portrait		File:ASSIST-UI-Tab-Portrait.png\|Assist UI Tablet Portrait
	File:ASSIST-UI-iPhone.png\|Assist UI iPhone		File:ASSIST-UI-iPhone.png\|Assist UI iPhone
	File:ASSIST-UI-Android-Long.png\|Assist UI Android (Long)		File:ASSIST-UI-Android-Long.png\|Assist UI Android (Long)
	</gallery>		</gallery></center>

	== Logging In ==		== Logging In ==

Anw: UI Layout

2025-06-20T12:51:44Z

UI Layout

← Older revision		Revision as of 14:51, 20 June 2025
Line 59:		Line 59:



			== Accessing the Systems ==
			Assists are accessed through a globally-available link <nowiki>https://calidusassist.adcservices.apteancloud.com/calidus-assist/{system}</nowiki>, such as:

			https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS - this Calidus HUB.

			There is a landing page available with links to each Assist here:

			https://calidusassist.adcservices.apteancloud.com/calidus-assist/

			The available systems are:

			* ''CALIDUS'' TMS
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS
			* ''CALIDUS'' Total Logistics TMS
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/CTL-TMS
			* ''CALIDUS'' ePOD
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/EPOD
			* ''CALIDUS'' Portal
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Portal
			* ''CALIDUS'' Vision (V1)
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/Vision
			* ''CALIDUS'' WCS
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WCS
			* ''CALIDUS'' WMS,
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/WMS
			* ''CALIDUS'' MCS
			** https://calidusassist.adcservices.apteancloud.com/calidus-assist/MCS

			You can access the systems through any internet connected device - the layout by default conforms to the best use of your screen size, for example:

			[[File:ASSIST-UI-PC.png\|800x800px]]
			[[File:ASSIST-UI-Tab-Landscape.png\|none\|thumb\|800x800px\|Assist UI Tablet Landscape]]
			<gallery widths="260" heights="600" perrow="3">
			File:ASSIST-UI-Tab-Portrait.png\|Assist UI Tablet Portrait
			File:ASSIST-UI-iPhone.png\|Assist UI iPhone
			File:ASSIST-UI-Android-Long.png\|Assist UI Android (Long)
			</gallery>

	== Logging In ==		== Logging In ==

Anw: Minor formatting change

2025-06-20T11:16:32Z

Minor formatting change

← Older revision		Revision as of 13:16, 20 June 2025
Line 15:		Line 15:
	* Ability to download any guide in Aptean formatted PDF document.		* Ability to download any guide in Aptean formatted PDF document.
	* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).		* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).





	Internally, Assist also provides:		Internally, Assist also provides:
Line 28:		Line 24:
	* Assistance creating new pages using templates		* Assistance creating new pages using templates
	** [[Help:CreateNewPage]]		** [[Help:CreateNewPage]]
	** [[Help:CreateNewWiki]]
	** [[Creating an ER]]		** [[Creating an ER]]

Line 64:		Line 59:


	~~== Basic Usage ==~~
	=== Logging In ===		== Logging In ==
	You don't need to log in to view pages on Assist, only if you want to edit them.		You don't need to log in to view pages on Assist, only if you want to edit them.

Line 74:		Line 69:
	You should change your user page within Assist to list your contact details (email and phone number) so that other users can easily contact you.		You should change your user page within Assist to list your contact details (email and phone number) so that other users can easily contact you.

	=== Reading ===		== Reading ==
	Each page is typically linked to from lots of different areas:		Each page is typically linked to from lots of different areas:

Line 85:		Line 80:
	When there is a link to another page, you can hover your mouse over it and the system will display a quick summary and an image to give you a flavour of the content before you click it. Not all links can display like this, but most do, and it's useful to get a preview of the contents of a link before you click into it.		When there is a link to another page, you can hover your mouse over it and the system will display a quick summary and an image to give you a flavour of the content before you click it. Not all links can display like this, but most do, and it's useful to get a preview of the contents of a link before you click into it.

	=== Contacting other users ===		== Contacting other users ==
	You can contact other users, including the admin of the system, using the user's talk pages.		You can contact other users, including the admin of the system, using the user's talk pages.

Line 96:		Line 91:
	{{Note}}You can only do this when you are logged in!		{{Note}}You can only do this when you are logged in!

	=== Searching ===		== Searching ==
	Although all pages from your ''CALIDUS'' system link directly to the appropriate page in this ''CALIDUS'' Assist guide, you can search for help on anything in the system using the search bar. It depends on how you have ''CALIDUS'' Assist configured, but this search bar is normally either in the title at the top of the screen or in the toolbar on the left.		Although all pages from your ''CALIDUS'' system link directly to the appropriate page in this ''CALIDUS'' Assist guide, you can search for help on anything in the system using the search bar. It depends on how you have ''CALIDUS'' Assist configured, but this search bar is normally either in the title at the top of the screen or in the toolbar on the left.

Line 112:		Line 107:
	* You can also control partial word matching with as asterisk. So let's say you are searching for a parameter called AUTO_SCHED something-or-other. Searching for AUTO_SCHED will not bring back any results, as there are no full words or phrases like that. But if you enter AUTO_SCHED_* instead, it will search for words ''starting with'' "AUTO_SCHED" and bring you back some matches.		* You can also control partial word matching with as asterisk. So let's say you are searching for a parameter called AUTO_SCHED something-or-other. Searching for AUTO_SCHED will not bring back any results, as there are no full words or phrases like that. But if you enter AUTO_SCHED_* instead, it will search for words ''starting with'' "AUTO_SCHED" and bring you back some matches.

	=== Searching Tables ===		== Searching Tables ==
	A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.		A lot of the pages have tables of data on them - this can be a bit difficult to see what you're after. So, in the cases where there is a large amount of data in tables, we have made the tables searchable.

Line 144:		Line 139:
	\|}		\|}

	=== Categories ===		== Categories ==
	Pages are typically categorised into groups, either for commonality or in a lot of cases so you can print all of the pages as a PDF book.		Pages are typically categorised into groups, either for commonality or in a lot of cases so you can print all of the pages as a PDF book.

Line 151:		Line 146:
	You can also see all categories from the Categories or Category Tree special pages.		You can also see all categories from the Categories or Category Tree special pages.

	=== Seeing Links ===		== Seeing Links ==
	Beyond just categories that have been set by the authors, you can also see what links to a particular page (and therefore more related information about that page) by clicking the ''What Links Here'' page tool.		Beyond just categories that have been set by the authors, you can also see what links to a particular page (and therefore more related information about that page) by clicking the ''What Links Here'' page tool.

Line 161:		Line 156:
	You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).		You can also click the ''Page Information'' tool to see what this page uses itself (i.e. pages that this page transcludes).

	=== Special Pages ===		== Special Pages ==
	You can access a lot of special pages from the Wiki Tools/Special Pages menu. Of interest are:		You can access a lot of special pages from the Wiki Tools/Special Pages menu. Of interest are:

Line 186:		Line 181:
	** Version - system component versions and software attributions		** Version - system component versions and software attributions

	=== Translation ===		== Translation ==
	The toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.		The toolbox contains a link to Google Translate to translate the page into a language of your choice. Select the language from the drop-down list, and Google will translate the whole page for you.

	=== Printing and Exporting ===		== Printing and Exporting ==
	You can export pages from ''CALIDUS'' Assist using the ''Print as PDF'' or ''Download as PDF'' link. Where this appears depends on the style the Assist is configured with, but by default this link will be in the ''Toolbox'' menu on the left of the screen, or on the tabs at the top right of the screen.		You can export pages from ''CALIDUS'' Assist using the ''Print as PDF'' or ''Download as PDF'' link. Where this appears depends on the style the Assist is configured with, but by default this link will be in the ''Toolbox'' menu on the left of the screen, or on the tabs at the top right of the screen.

Anw: Updated

2025-06-20T11:09:49Z

Updated

← Older revision		Revision as of 13:09, 20 June 2025
Line 12:		Line 12:
	* Web-accessible help direct to customers.		* Web-accessible help direct to customers.
	* Web-accessible help per page, which can be linked to from our applications.		* Web-accessible help per page, which can be linked to from our applications.
			** [[Assist Help Config in Other Systems]]
	* Ability to download any guide in Aptean formatted PDF document.		* Ability to download any guide in Aptean formatted PDF document.
	* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).		* Faster, more accurate and appropriate searching of functionality (compared to hosted documents).





Line 22:		Line 26:
	* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write all" sensibilities and reduces duplication of effort.		* Transclusion - the text from any page can be pulled directly into any other page through transclusion. This promotes "write once, write all" sensibilities and reduces duplication of effort.
	* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.		* Templates - promoting a similar look and feel to all documents, templates can be used to ensure that documents look like Aptean documents, that warnings and informational noted look the same, etc. This improves readability for the end users.
			* Assistance creating new pages using templates
			** [[Help:CreateNewPage]]
			** [[Help:CreateNewWiki]]
			** [[Creating an ER]]

Anw: Updated

2025-06-20T11:06:02Z

Updated

Show changes