Help:CreateNewPage: Difference between revisions

From Calidus HUB
(Added ability to create pages and documents if logged in)
(Updated)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
You must be logged in to be able to create new pages in Assist. When you are, shortcuts to create new pages will appear below here.
{{Note}} You must be logged in to be able to create new pages in Assist.
 
When you are, shortcuts to create new pages will appear below here.
 


<div style="display:none;" class="apt-user-show">
<div style="display:none;" class="apt-user-show">
{{Note}} Choose your document titles well - these will be included in the printed/output PDF documents on the top of every page, and therefore should be very descriptive - examples are provided of the standards being followed.
Similarly, the Products chosen when creating the new page should be used from the list below. This is because the Assist system automatically categorises all pages into sub-categories by Product based on your entry. Choosing the right one means that this is automatic and will be most useful to those using the system.
* CTMS
* EPOD
* MCS
* ASSIST
* TCM
* VEhub
* Vision
* WCS
* PORTAL
* WMS
* Bay Diary
* TOC
== New Pages ==
=== Document ===
* UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide
* Area - Description Guide e.g. Orders - Order Guide
<inputbox>
<inputbox>
type=create
type=create
Line 7: Line 33:
preload=DocTemplate
preload=DocTemplate
break=yes
break=yes
placeholder=Enter Document to Create e.g. Orders - Order Guide
placeholder=Enter Document Name e.g.  
</inputbox>
</inputbox>
=== Page ===
* Name e.g. Planning
* ProgNum e.g. SOS1000, PTV_CONFIG
* Something Guide e.g. Orders Guide
* Screen - Something Tab e.g. Goods Receipt - Details Tab


<inputbox>
<inputbox>
Line 15: Line 47:
preload=PageTemplate
preload=PageTemplate
break=yes
break=yes
placeholder=Enter Page to Create e.g. PTV_CONFIG
placeholder=Enter Page Name
</inputbox>
</inputbox>
</div>
</div>
== Patches/Release Notes ==
Release notes are broadly in different formats, but all release notes will be categorised automatically for you.
A guide to creating ERs is available here: [[Creating an ER]]. Although this is specific to the ER process, the guide is mostly applicable to all other release documents as well.
=== WMS or TMS Patch ===
* CTMS e.g. PATCH C-TMS P091
* WMS e.g. PATCH WMS P091


<inputbox>
<inputbox>
Line 24: Line 66:
preload=Template:TMS_PATCH
preload=Template:TMS_PATCH
break=yes
break=yes
placeholder=Enter Patch to Create e.g. PATCH CTMS P091 210716
placeholder=Enter Patch Name
</inputbox>
</inputbox>
=== WMS or CTMS Emergency Release ===
* CTMS e.g. ER C-TMS 047-001
* WMS e.g. ER WMS 046-001


<inputbox>
<inputbox>
Line 32: Line 78:
preload=Template:ER
preload=Template:ER
break=yes
break=yes
placeholder=Enter Emergency Release to Create e.g. ER CTMS 046-060‎
placeholder=Enter Emergency Release Name
</inputbox>
</inputbox>
=== WCS Patch ===
* Generic - UP{DateYYMMDD}_{Client} e.g. UP250709
* Client Specific - UP{DateYYMMDD}_{Client} e.g.  UP250709_CER


<inputbox>
<inputbox>
Line 40: Line 90:
preload=Template:WCS_PATCH
preload=Template:WCS_PATCH
break=yes
break=yes
placeholder=Enter WCS Build Number Here e.g. UP20150529
placeholder=Enter WCS Build Number
</inputbox>
</inputbox>
=== EPOD Device/APK Release Note ===
* e.g. Calidus ePOD Android v4.5 APK 4.05.01.20


<inputbox>
<inputbox>
type=create
type=create
buttonlabel=Create New Doc Title
buttonlabel=Create New EPOD APK Release Note
preload=Template:Doc_Title
preload=Template:EPOD_RelNote
break=yes
placeholder=Enter EPOD APK Relnote
</inputbox>
 
=== EPOD Admin/Server Release Note ===
* e.g. Calidus ePOD Server 4.5.1.12
 
<inputbox>
type=create
buttonlabel=Create New EPOD Admin/Server Release Note
preload=Template:EPOD_Admin_RelNote
break=yes
placeholder=Enter EPOD Admin/Server Relnote
</inputbox>
 
=== Portal Release Note ===
* REL Sys Version Client-Optional
* e.g. REL Portal 2.03.01
* e.g. REL Portal 11.03.01 CTY
 
<inputbox>
type=create
buttonlabel=Create New Portal Release Note
preload=Template:Portal_RelNote
break=yes
break=yes
placeholder=Enter Doc Title Page to Create e.g. My Document Title
placeholder=Enter Relnote
</inputbox>
</inputbox>
=== General Release Note ===
* REL Sys Version Client-Optional
* e.g. REL MCS 2.03.01
* e.g. REL Portal 11.03.01 CTY


<inputbox>
<inputbox>
type=create
type=create
buttonlabel=Create New Doc Appendix
buttonlabel=Create New General Release Note
preload=Template:Doc_Appendix
preload=Template:General_RelNote
break=yes
break=yes
placeholder=Enter Doc Appendix Page to Create e.g. My Document Appendix
placeholder=Enter Relnote
</inputbox>
</inputbox>
== Specific Document Types ==
=== Functional Specification ===
* FS 123456 Client - DocName


<inputbox>
<inputbox>
Line 64: Line 151:
preload=Template:FS
preload=Template:FS
break=yes
break=yes
placeholder=Enter FS title to Create e.g. FS 123456 Client - Functionality
placeholder=Enter FS title  
</inputbox>
</inputbox>
=== Estimate ===
* EST 123456 (ClientRef) Client - DocName


<inputbox>
<inputbox>
type=create
type=create
buttonlabel=Create New EST
buttonlabel=Create New EST
preload=Template:EST
preload=Template:Estimate_Template
break=yes
break=yes
placeholder=Enter EST to Create e.g. EST 123456 Client - Functionality
placeholder=Enter EST title
</inputbox>
</inputbox>
=== Solution Design ===
* SDD 123456 Client Solution Design


<inputbox>
<inputbox>
Line 80: Line 173:
preload=Template:REQ
preload=Template:REQ
break=yes
break=yes
placeholder=Enter EST to Create e.g. SDD 123456 Client
placeholder=Enter SDD name
</inputbox>
</inputbox>
=== Small Change Request ===
* SCR 123456 - DocName


<inputbox>
<inputbox>
Line 88: Line 184:
preload=Template:SmallCR
preload=Template:SmallCR
break=yes
break=yes
placeholder=Enter Small Change Request to Create e.g. SCR 123456 - Functionality
placeholder=Enter Small CR name
</inputbox>
</inputbox>


== Category Utility Pages==
These are used when creating a title page and appendix page to group loads of categorised pages into a single combined book.


</div>
=== Document Title Page ===
* {DocName} Title e.g. similar to the Document titles above
** UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Title
** Area - Description Guide e.g. Orders - Order Guide Title


<!--
<inputbox>
{{Warning}} In later versions, this functionality will be replaced and is therefore defunct. However, this old version might contain some useful information, so is preserved.
type=create
buttonlabel=Create New Doc Title
preload=Template:Doc_Title
break=yes
placeholder=Enter Doc Title Page Name
</inputbox>


You can create new pages from the templates set up for you by following these links:
=== Document Appendix Page ===
* {DocName} Appendix e.g. similar to the Document titles above
** UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Appendix
** Area - Description Guide e.g. Orders - Order Guide Appendix


<inputbox>
type=create
buttonlabel=Create New Doc Appendix
preload=Template:Doc_Appendix
break=yes
placeholder=Enter Doc Appendix Page Name
</inputbox>


=Create Document Title Page=
</div>
<spoiler><makearticle> Template:Doc_Title </makearticle></spoiler>
 
=Create Document Appendix Page=
<spoiler><makearticle> Template:Doc_Appendix </makearticle></spoiler>
 
=Create Estimate=
<spoiler><makearticle> Template:EstimateNew </makearticle></spoiler>
 
=Create Functional Specification=
<createarticle>
type=createarticle
preload=Template:FS
align=left
default=Enter FS Name Here
buttonlabel=Create FS
</createarticle>
 
=Create Requirements=
<createarticle>
type=createarticle
preload=Template:REQ
align=left
default=Enter Requirements Name Here
buttonlabel=Create REQ
</createarticle>
 
=Create Small Change Request =
<spoiler><makearticle> Template:SmallCR </makearticle></spoiler>
 
=Create ER Documentation=
<createarticle>
type=createarticle
preload=Template:ER
align=left
default=Enter Emergency Release Name Here (e.g. ER WMS770 ER003-001)
buttonlabel=Create ER
</createarticle>
=Create PATCH Documentation=
<createarticle>
type=createarticle
preload=Template:TMS_PATCH
align=left
default=Enter Patch Name Here e.g. PATCH WMS 810 P091 210716
buttonlabel=Create PATCH
</createarticle>
<createarticle>
type=createarticle
preload=Template:WCS_PATCH
align=left
default=Enter WCS Build Number Here e.g. UP20150529
buttonlabel=Create WCS PATCH
</createarticle>
-->
[[Category:ASSIST]]
[[Category:ASSIST]]

Latest revision as of 15:26, 8 August 2025

Note Note: You must be logged in to be able to create new pages in Assist.

When you are, shortcuts to create new pages will appear below here.


Patches/Release Notes

Release notes are broadly in different formats, but all release notes will be categorised automatically for you.

A guide to creating ERs is available here: Creating an ER. Although this is specific to the ER process, the guide is mostly applicable to all other release documents as well.


WMS or TMS Patch

  • CTMS e.g. PATCH C-TMS P091
  • WMS e.g. PATCH WMS P091

WMS or CTMS Emergency Release

  • CTMS e.g. ER C-TMS 047-001
  • WMS e.g. ER WMS 046-001

WCS Patch

  • Generic - UP{DateYYMMDD}_{Client} e.g. UP250709
  • Client Specific - UP{DateYYMMDD}_{Client} e.g. UP250709_CER

EPOD Device/APK Release Note

  • e.g. Calidus ePOD Android v4.5 APK 4.05.01.20

EPOD Admin/Server Release Note

  • e.g. Calidus ePOD Server 4.5.1.12

Portal Release Note

  • REL Sys Version Client-Optional
  • e.g. REL Portal 2.03.01
  • e.g. REL Portal 11.03.01 CTY

General Release Note

  • REL Sys Version Client-Optional
  • e.g. REL MCS 2.03.01
  • e.g. REL Portal 11.03.01 CTY


Specific Document Types

Functional Specification

  • FS 123456 Client - DocName

Estimate

  • EST 123456 (ClientRef) Client - DocName

Solution Design

  • SDD 123456 Client Solution Design

Small Change Request

  • SCR 123456 - DocName

Category Utility Pages

These are used when creating a title page and appendix page to group loads of categorised pages into a single combined book.

Document Title Page

  • {DocName} Title e.g. similar to the Document titles above
    • UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Title
    • Area - Description Guide e.g. Orders - Order Guide Title

Document Appendix Page

  • {DocName} Appendix e.g. similar to the Document titles above
    • UG DevOps System Description Guide e.g. UG 106181 WCS Maintenance Guide Appendix
    • Area - Description Guide e.g. Orders - Order Guide Appendix