วิธีปรับแต่งส่วนติดต่อผู้ใช้ของ CODE และซ่อนแถบเครื่องมือเฉพาะ

คำตอบสั้นๆ:ใน CODE ให้เปลี่ยนรูปแบบแถบเครื่องมือโดยรวมด้วยการตั้งค่ามุมมองแบบกะทัดรัด (Compact) หรือแบบแท็บ (Tabbed) หากต้องการซ่อนแท็บสมุดบันทึกหรือคำสั่งใดคำสั่งหนึ่ง วิธีที่รองรับคือการใช้ API PostMessage ของโฮสต์ WOPI เมนูปกติของโปรแกรมดูจะไม่ลบคำสั่งแต่ละรายการอย่างถาวรสำหรับทุกคน ผู้ดูแลระบบสามารถตั้งค่าโหมดอินเทอร์เฟซเริ่มต้นสำหรับเซิร์ฟเวอร์ได้ ในขณะที่โฮสต์ที่ฝัง CODE สามารถส่งข้อความซ่อนหรือแสดงในระดับเซสชันได้

เลือกวิธีการที่ตรงกับสิทธิ์การเข้าถึงของคุณ หากคุณต้องการพื้นที่เอกสารเพิ่มขึ้น ให้ยุบแถบเครื่องมือหรือเปลี่ยนไปใช้มุมมองแบบกะทัดรัด หากการผสานรวม WOPI ของคุณควรละเว้นแท็บช่วยเหลือหรือคำสั่งการจัดรูปแบบ ให้ส่ง PostMessage ที่เกี่ยวข้องหลังจากที่ตัวแก้ไขพร้อมใช้งานแล้ว หากเป้าหมายของคุณคือการป้องกันการกระทำ เช่น การพิมพ์ การดาวน์โหลด หรือการแก้ไข ให้ใช้ความสามารถหรือสิทธิ์ WOPI ที่เกี่ยวข้องด้วย การซ่อนปุ่มจะเปลี่ยนการแสดงผล ไม่ใช่การอนุญาต

เลือกการปรับแต่งที่เหมาะสม

คู่มือ SDK ที่เกี่ยวข้องระบุHide_NotebookTabว่าสามารถใช้งานได้ตั้งแต่เวอร์ชัน 24.04.11.1 และHide_Command24.04.11.2 เป็นต้นไป แพ็กเกจการเผยแพร่ CODE และบิลด์สำหรับอินทิเกรเตอร์อาจแตกต่างกัน ดังนั้นโปรดตรวจสอบเวอร์ชันของเซิร์ฟเวอร์ที่คุณใช้งานจริงก่อนที่จะเชื่อถือข้อความ API

เปลี่ยนค่าเริ่มต้นระหว่างมุมมองแบบกะทัดรัดและแบบแท็บ

มุมมองแบบกะทัดรัดใช้เมนูและแถบเครื่องมือขนาดเล็กกว่า มุมมองแบบแท็บจะจัดกลุ่มการควบคุมไว้ในแท็บของแถบโน้ตบุ๊ก การตั้งค่าเซิร์ฟเวอร์คือuser_interface.modeโดยมีค่าที่รองรับcompactคือ และtabbedป้ายกำกับแบบเก่า เช่นclassicและnotebookbarถูกยกเลิกแล้วและให้ใช้ชื่อเหล่านี้แทน

สำหรับการตั้งค่าเริ่มต้นที่ควบคุมโดยผู้ดูแลระบบ ให้แก้ไข<mode>รายการที่มีอยู่ภายใน<user_interface>ส่วนของcoolwsd.xml:

<user_interface>
  <mode type="string" desc="Controls the user interface style. The 'default' means: Take the value from ui_defaults, or decide for one of compact or tabbed (default|compact|tabbed)" default="default">tabbed</mode>
</user_interface>

ใช้compactแทนtabbedสำหรับเมนูแบบกะทัดรัด ในไฟล์การกำหนดค่าจริง ให้แก้ไขรายการโหมดที่มีอยู่แทนที่จะเพิ่มรายการที่สอง เส้นทางการกำหนดค่าที่แน่นอนและขั้นตอนการรีสตาร์ทจะขึ้นอยู่กับว่า CODE ถูกติดตั้งเป็นแพ็กเกจ คอนเทนเนอร์ หรือผ่านแพลตฟอร์มอื่น ให้ปฏิบัติตามวิธีการกำหนดค่าของการติดตั้งนั้น รีสตาร์ทหรือโหลดบริการใหม่ตามต้องการ และเปิดเซสชันเอกสารใหม่เพื่อยืนยันค่าเริ่มต้น

การตั้งค่านี้เป็นการกำหนดโหมดอินเทอร์เฟซเริ่มต้น ไม่ได้ซ่อนคำสั่งใด ๆ โดยเฉพาะ ผู้ใช้หรือผู้รวมระบบอาจบันทึกการตั้งค่าอินเทอร์เฟซไว้ ซึ่งจะมีผลเหนือกว่า ขึ้นอยู่กับการกำหนดค่าสถานะ UI ที่บันทึกไว้ของเซิร์ฟเวอร์ หากเบราว์เซอร์หนึ่งเปิดขึ้นมาในมุมมองที่แตกต่างกัน ให้ลองเริ่มเซสชันใหม่และตรวจสอบพฤติกรรมการตั้งค่าของผู้ใช้ก่อนที่จะเปลี่ยนแปลงการตั้งค่าเซิร์ฟเวอร์เพิ่มเติม

ยุบแถบเครื่องมือโดยไม่ลบคำสั่ง

เมื่อต้องการเพิ่มพื้นที่จัดเก็บเอกสาร การยุบแถบแท็บในแถบสมุดบันทึกมักจะเพียงพอแล้วCollapse_Notebookbarข้อความจาก SDK จะซ่อนปุ่มในแถบสมุดบันทึก แต่ชื่อแท็บยังคงใช้งานได้เพื่อให้ผู้ใช้สามารถขยายส่วนควบคุมได้อีกครั้ง ข้อความเดียวกันนี้ยังซ่อนแถบปุ่มในมุมมองแบบกะทัดรัดด้วย นี่เป็นการเปลี่ยนแปลงการแสดงผลที่สามารถย้อนกลับได้ ไม่ใช่วิธีปิดใช้งานคุณสมบัติการแก้ไข

ในอินเทอร์เฟซที่รองรับ ผู้ใช้ยังสามารถยุบหรือขยายแถบโน้ตบุ๊กได้โดยการโต้ตอบกับแถบแท็บ ลักษณะการคลิกหรือดับเบิ้ลคลิกอาจแตกต่างกันไปตามมุมมองและเวอร์ชัน หากผู้ใช้ต้องการคืนค่าแถบที่ยุบอยู่ ให้คงชื่อแท็บไว้ให้มองเห็นได้ และทดสอบการกระทำในเวอร์ชัน CODE เดียวกันกับที่พวกเขาใช้

ซ่อนแท็บหรือคำสั่งหนึ่งรายการในการผสานรวม WOPI

การซ่อนโค้ดต่อเซสชันนั้นจำเป็นต้องมีแอปพลิเคชันโฮสต์ที่ฝังโค้ดไว้ใน iframe และสามารถส่งข้อความไปยัง iframe นั้นได้ นี่ไม่ใช่การตั้งค่าทั่วไปที่สามารถคัดลอกไปวางได้coolwsd.xmlAPI PostMessage ใช้ข้อความที่มีแท็ก <script> MessageId, การประทับเวลา และ <textarea> (ไม่บังคับValues) โฮสต์ WOPI ต้องทำการแลกเปลี่ยนข้อมูลความพร้อมให้เสร็จสมบูรณ์ก่อนที่จะส่งคำสั่งแก้ไข กำหนดค่า WOPI PostMessageOriginสำหรับหน้าโฮสต์และใช้ต้นทาง iframe ของโค้ดที่แน่นอนเป็นเป้าหมายข้อความของเบราว์เซอร์ อย่าใช้ต้นทางเป้าหมายแบบไวด์การ์ด

หลังจากโฮสต์ได้รับApp_LoadingStatusเหตุการณ์ความพร้อมใช้งานที่เหมาะสมและส่งข้อความแล้วHost_PostmessageReadyโฮสต์สามารถส่งข้อความซ่อนได้ ตัวอย่างเช่น การเรียกใช้ต่อไปนี้จะซ่อนแท็บช่วยเหลือและคำสั่งขีดเส้นใต้สำหรับเซสชันตัวแก้ไขที่เปิดอยู่:

const frame = document.getElementById("collaboraFrame");
const collaboraOrigin = "https://office.example.com";

function sendToCollabora(MessageId, Values = {}) {
  frame.contentWindow.postMessage({
    MessageId,
    SendTime: Date.now(),
    Values
  }, collaboraOrigin);
}

// Call after the WOPI PostMessage readiness exchange.
sendToCollabora("Hide_NotebookTab", { id: "Help" });
sendToCollabora("Hide_Command", { id: ".uno:Underline" });

แทนที่office.example.comด้วยต้นทางของ iframe ของ CODE ของคุณเอง ตัวอย่างนี้แสดงให้เห็นถึงรูปแบบของข้อความ เชื่อมต่อเข้ากับวงจรชีวิตของ iframe จริงของโฮสต์ และตรวจสอบความถูกต้องของต้นทางของข้อความที่เข้ามา ก่อนที่จะตอบกลับ เอกสารประกอบของ CODE ระบุว่า ข้อความจากโฮสต์ที่ส่งมาก่อนHost_PostmessageReadyอาจถูกละเลย

คุณควรใช้ข้อความใด?

• Hide_NotebookTab:ใช้สำหรับแท็บทั้งหมดในมุมมองแบบแท็บ โดยจะidเป็น ID ของแท็บ เช่นHelp. Show_NotebookTabการเปลี่ยนแปลงจะถูกย้อนกลับ แท็บจะถูกซ่อนไว้จนกว่าจะมีข้อความแสดงขึ้นมา
• Hide_Command:ใช้เมื่อต้องการให้คำสั่งนั้นหายไปจากเมนู แถบเครื่องมือ และเมนูบริบท ตัวอย่าง ID คือ.uno:Underline. Show_Commandจะกลับกัน ใช้เฉพาะเมื่อต้องการลบคำสั่งนั้นออกจากทุกส่วนที่เกี่ยวข้องเท่านั้น
• Hide_Button:ใช้เมื่อคุณต้องการซ่อนปุ่มเพียงปุ่มเดียว แทนที่จะซ่อนรายการ UI ทั้งหมดสำหรับคำสั่งนั้น รหัสของมันคือรหัสของปุ่มบนแถบเครื่องมือ ไม่จำเป็นต้องเป็นชื่อคำสั่งของ UNO เอกสารของ Collabora ระบุว่ารหัสเหล่านี้มักจะคงที่ แต่ไม่รับประกัน โปรดตรวจสอบกับซอร์สโค้ดสำหรับเวอร์ชันและการใช้งานอุปกรณ์ของคุณอย่างละเอียด
• Hide_Menubar:คำสั่งนี้จะซ่อนแถบเมนูทั้งหมด ไม่ใช่การควบคุมแบบเฉพาะคำสั่ง และไม่ควรสับสนกับการซ่อนแท็บในแถบโน้ตบุ๊ก

API postMessage มีไว้สำหรับโฮสต์การผสานรวม หากคุณใช้งาน Nextcloud, ownCloud หรือแพลตฟอร์มอื่น โปรดตรวจสอบว่าตัวเชื่อมต่อของแพลตฟอร์มนั้นมีตัวเลือกที่รองรับหรือไม่ ก่อนที่จะสร้างโค้ดโฮสต์แบบกำหนดเอง หลีกเลี่ยงการแทรก CSS ลงในหน้าแก้ไข เนื่องจากมีความเปราะบางในเวอร์ชันต่างๆ และเพียงแค่ซ่อนการควบคุมในเชิงภาพเท่านั้น

ตรวจสอบให้แน่ใจว่าการเปลี่ยนแปลงนั้นเหมาะสมกับกรณีการใช้งานของคุณ

เปิดเอกสารทดสอบโดยใช้เบราว์เซอร์ ประเภทเอกสาร สิทธิ์การเข้าถึง และเวอร์ชัน CODE เดียวกันกับผู้ใช้ของคุณ ยืนยันโหมดที่เลือก ตรวจสอบว่ามีเพียงแท็บหรือคำสั่งที่ต้องการเท่านั้นที่ถูกซ่อน และทดสอบการแสดงข้อความหรือการขยายแถบเครื่องมือที่ตรงกัน ทำซ้ำสำหรับ Writer, Calc และ Impress หากการผสานรวมของคุณให้บริการทั้งสามโปรแกรม คำสั่งและรหัสแถบเครื่องมือที่มีอยู่อาจไม่เหมือนกันระหว่างโมดูล

หากยังคงปรากฏการควบคุมที่ซ่อนอยู่ ให้ตรวจสอบว่าโฮสต์ที่ส่งข้อความ นั้นถูกต้อง ตรวจสอบ Host_PostmessageReadyว่า WOPI PostMessageOriginและต้นทางเป้าหมายของ iframe นั้นถูกต้อง และข้อความนั้นใช้ ID และการสะกดคำที่ถูกต้องตามที่คาดไว้ นอกจากนี้ ให้ตรวจสอบเวอร์ชันของเซิร์ฟเวอร์เทียบกับเวอร์ชันพื้นฐานที่ระบุไว้ในเอกสาร การซ่อนแบบมองเห็นได้สำเร็จไม่ได้ลบคำสั่งออกจากเอ็นจิ้นเอกสารพื้นฐานหรือสร้างข้อจำกัดด้านความปลอดภัย ใช้สิทธิ์ WOPI และนโยบายแบ็กเอนด์สำหรับการควบคุมการเข้าถึง

เอกสารอ้างอิงอย่างเป็นทางการ

• คู่มือการใช้งาน Collabora Online SDK เวอร์ชัน 24.04: การกำหนดค่าและการใช้งาน PostMessage API
• เอกสารประกอบ API PostMessage ของ Collabora Online SDK
• บันทึกการเปลี่ยนแปลงของ CODE เวอร์ชัน 26.04
• บันทึกการเปลี่ยนแปลงของ CODE เวอร์ชัน 21.11: ตัวเลือกการสลับมุมมองแบบกะทัดรัดและแบบแท็บ