สลับไปใช้วิธีใช้ HTML

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

ฉันสงสัยว่าถ้ามีทางเลือกให้ chm? สิ่งที่ฉันกำลังมองหาคือสิ่งที่สามารถใช้งานแบบออฟไลน์ได้ (สิ่งนี้สำคัญเนื่องจากผู้ใช้ของเราจำนวนเล็กน้อยอยู่ในสถานที่ห่างไกล) ด้วยซอฟต์แวร์ของเรา ควรมีดัชนี (สามารถทำได้ง่ายเหมือนหน้า html ที่มีคำไฮเปอร์ลิงก์) ควรค้นหาได้และควรมีกลไกที่อนุญาตให้มีการเรียกรายการเฉพาะจากรหัส (คล้ายกับวิธีใช้ตามบริบท)

สองสิ่งที่ขัดแย้งกับ PDF ในกรณีนี้คือ:

1. ความช่วยเหลือที่มีความละเอียดอ่อนตามบริบทไม่ใช่ตัวเลือก
2. โดยทั่วไปแล้วเอกสารมีขนาดค่อนข้างใหญ่
3. PDF เหมาะสมกับเอกสารที่พิมพ์มากกว่าวิธีใช้แบบตามบริบท

สิ่งที่ฉันต้องการคือการใช้ html ปัญหาเดียวของ html คือฉันไม่สามารถหาวิธีให้การค้นหาคำหลักได้โดยอัตโนมัติ (นอกเหนือจากฟังก์ชัน ctrl + f ของเบราว์เซอร์ - ฉันต้องการสิ่งที่ชัดเจนกว่า) ฉันไม่สามารถหาวิธีในการสร้างดัชนีไฮเปอร์ลิงก์ของคำสำคัญได้โดยอัตโนมัติ ความช่วยเหลือที่ละเอียดอ่อนตามบริบทนั้นง่ายเนื่องจากแท็กส่วน - ฉันสามารถส่ง URL ของหน้าและส่วนที่ฉันสนใจในเบราว์เซอร์เริ่มต้นและหน้านั้นควรโหลดจนถึงส่วนที่ถูกต้อง

ความต้องการของฉันฟังดูแย่มากเหมือน chm - พวกเขาทำ ฉันทำแบบจำลองตามข้อกำหนดของฉัน เหตุผลเดียวที่ฉันไม่ชอบ chm เป็นเพราะวิธีการที่รหัสโต้ตอบกับมันโดยใช้ mapids และเช่นนั้น ฉันจะค่อนข้างใช้เก็บรายการข้อความธรรมดา (ที่สร้างขึ้นโดยอัตโนมัติสำหรับฉัน) ที่รหัสของฉันสามารถใช้ในการเข้าถึงบริบทส่วนที่สำคัญของเอกสาร

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

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

แก้ไข:

ฉันออกแบบซอฟต์แวร์ที่ใช้โดยอุตสาหกรรมการขุด เหมืองจำนวนมากอยู่ในระยะไกลและไม่สามารถเข้าถึงอินเทอร์เน็ตได้อย่างมีความหมาย ไม่มีอะไรผิดปกติกับ pdf หรือ html หรือ chm (ยกเว้นว่ามันเริ่มเก่าแล้ว) ถ้าฉันสามารถแสดงไฟล์ pdf ในตำแหน่งที่ถูกต้อง (เช่นความช่วยเหลือที่ไวต่อบริบท) ฉันจะใช้มัน ฉันเกือบอยากจะเขียนของตัวเอง - โดยพื้นฐานแล้วมันจะเป็น wiki แบบพกพา ถ้าคุณแนะนำ wiki แบบพกพาคุณต้องคิดถึงผู้ใช้ปลายทางซึ่งอาจไม่มีประสบการณ์ในการใช้เครื่องมือดังกล่าว มันจะต้องมีคนตายง่าย ๆ นั่นคือความงามของ CHM ​​มันเป็นความเจ็บปวดในการทำงานด้วย แต่ผู้ใช้ปลายทางชอบมัน

หากคุณพร้อมที่จะเขียนความช่วยเหลือของคุณในมาร์กอัป XML ของ DocBook แทนที่จะเป็น HTML DocBook มีส่วนช่วยในการผลิต WebHelp: http://wiki.docbook.org/WebHelp

เอกสาร WebHelp ยังเป็นตัวอย่างของผลลัพธ์: http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html

มันให้รูปแบบวิธีใช้ HTML บนเว็บซึ่งประกอบด้วย:

• ค้นหาข้อความแบบเต็มด้วย:
  • Stemming รองรับภาษาอังกฤษฝรั่งเศสและเยอรมัน การสนับสนุน Stemming สามารถเพิ่มได้สำหรับภาษาอื่น ๆ โดยการใช้ Stemmer
  • รองรับภาษาจีนญี่ปุ่นและเกาหลีโดยใช้รหัสจากเครื่องมือค้นหา Lucene
  • การไฮไลต์การค้นหาที่แสดงตำแหน่งที่ค้นหาคำปรากฏในผลลัพธ์
  • ผลการค้นหาสามารถรวมคำอธิบายสั้น ๆ ของเป้าหมาย
• สารบัญบานหน้าต่างที่มีแผนผัง TOC ที่ยุบได้
• การซิงโครไนซ์ของบานหน้าต่างเนื้อหาและ TOC โดยอัตโนมัติ
• TOC และบานหน้าต่างค้นหาถูกนำไปใช้โดยไม่ต้องใช้ frameset
• ไฟล์ Ant build.xml เพื่อสร้างเอาต์พุต

ผู้สร้าง RoboHelp ได้ไปทำอย่างอื่นและกลับมาอีกรอบเพื่อสร้างทางเลือกที่ดีกว่า ตรวจสอบFlare ของ MadCap - รองรับหลากหลายรูปแบบเอาต์พุตสร้างดัชนีและจัดหาฟังก์ชันการค้นหาที่ทำงานในพื้นที่ (ผ่าน JavaScript)

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

CHM เองกำลังจะแก่ขึ้นและ Microsoft ก็เปลี่ยนไปใช้สิ่งใหม่กว่า: http://msdn.microsoft.com/en-us/library/bb164608(v=vs.80).aspx

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

• เพิ่มเซิร์ฟเวอร์ HTTP โลคัลโฮสต์ขนาดเล็กให้กับโปรเจ็กต์เพื่อให้บริการเว็บไซต์พร้อมกับเอกสารคู่มือ ปัญหาคือเวลาหรือวิธีการเริ่ม / หยุดเซิร์ฟเวอร์ HTTP นี้และ / หรือให้มันทำงานอยู่ อีกทางเลือกหนึ่งคือการใช้รูปแบบ URL ที่กำหนดเอง แต่สิ่งนี้จะผูกคุณกับเบราว์เซอร์เดียวและทำงานได้มากขึ้น ( และฉันบอกได้ )

• เขียนเครื่องมือค้นหา JavaScript JavaScript ในเบราว์เซอร์ใด ๆ ก็ได้รับความรวดเร็วและมีประสิทธิภาพ ดัชนีคำหลักสามารถจัดเก็บได้อย่างง่ายดายบน JSON และฉันได้เรียกใช้นิพจน์ทั่วไปในไฟล์ในเครื่องที่ให้ผลลัพธ์ที่ดี

สิ่งที่ฉันกำลังมองหาคือสิ่งที่สามารถใช้งานแบบออฟไลน์ได้ (สิ่งนี้สำคัญเนื่องจากผู้ใช้ของเราจำนวนเล็กน้อยอยู่ในสถานที่ห่างไกล) ด้วยซอฟต์แวร์ของเรา

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

ควรค้นหาได้และควรมีกลไกที่อนุญาตให้เรียกใช้รายการที่ระบุได้

เราใช้หน้าเว็บบางหน้าใน RoboHelp เพื่ออธิบายการใช้งานบางฟิลด์บนหน้าจอ เราสามารถมีป๊อปอัปสำหรับฟิลด์เหล่านั้นที่ปรากฏหลังจากคลิกได้ RoboHelp มีความสามารถในการค้นหาที่ดีมากและสร้างดัชนีโดยอัตโนมัติ ฉันโชคดีที่ได้ค้นหามันเสมอ นี่อาจไม่ใช่ปัญหาใหญ่สำหรับคุณ แต่เราสามารถให้ทุกคนอัปเดตเอกสารได้เพราะ RoboHelp เป็นโปรแกรมที่ใช้งานง่าย