এইচটিএমএল সাহায্যে বিকল্প রূপান্তরিত করে


12

আমরা বর্তমানে AsciiDoc নামক একটি সিস্টেম ব্যবহার করি যা আমাদের একটি সাধারণ পাঠ্য মার্কআপে ডকুমেন্টেশন তৈরি করতে দেয়। এটি থেকে আমরা একাধিক আউটপুট ফর্ম্যাট তৈরি করতে পারি। আমরা কেবল পিডিএফ আউটপুট এবং chm আউটপুট ফর্ম্যাট ব্যবহার করি।

আমি ভাবছিলাম chm এর বিকল্প ছিল কিনা? আমি যা খুঁজছি তা হ'ল এমন একটি যা অফ-লাইন ব্যবহার করা যায় (এটি গুরুত্বপূর্ণ কারণ আমাদের বেশ কয়েকটি ব্যবহারকারী খুব দূরবর্তী স্থানে রয়েছেন) আমাদের সফ্টওয়্যার সহ। এটির একটি সূচক থাকতে হবে (এটি হাইপারলিংকড শর্তাবলী সহ এইচটিএমএল পৃষ্ঠার মতো সহজ হতে পারে), এটি অনুসন্ধানযোগ্য হওয়া উচিত এবং এতে একটি প্রক্রিয়া থাকা উচিত যা কোড থেকে নির্দিষ্ট এন্ট্রিগুলি কল করার অনুমতি দেয় (প্রসঙ্গে সংবেদনশীল সাহায্যের অনুরূপ)।

এই ক্ষেত্রে দুটি জিনিস যা পিডিএফের বিরুদ্ধে রয়েছে তা হ'ল:

  1. প্রসঙ্গে সংবেদনশীল সহায়তা কোনও বিকল্প নয়
  2. সাধারণত ডকুমেন্টটি বরং বড় হয়
  3. পিডিএফ প্রসঙ্গে সংবেদনশীল সাহায্যের চেয়ে মুদ্রিত ডকুমেন্টেশনের পক্ষে বেশি উপযুক্ত

আমি যা চাই তা এইচটিএমএল ব্যবহার করা। এইচটিএমএলটির একমাত্র সমস্যা হ'ল আমি কীভাবে কীওয়ার্ড অনুসন্ধান (ব্রাউজারগুলি সিটিআরএল + এফ কার্যকারিতা ব্যতীত - কীভাবে আরও স্পষ্ট কিছু চাই) সরবরাহ করতে পারি তা বুঝতে পারি না can't মূল শব্দের একটি হাইপার-লিঙ্কড সূচক স্বয়ংক্রিয়ভাবে উত্পন্ন করার জন্য আমি কোনও পদ্ধতি খুঁজে পাচ্ছি না। বিভাগের ট্যাগগুলির কারণে প্রসঙ্গে সংবেদনশীল সহায়তা সহজ হবে - আমি কেবল পৃষ্ঠা এবং বিভাগটির ইউআরএলটি পাস করতে পারি যে আমি ডিফল্ট ব্রাউজারে আগ্রহী এবং সেই পৃষ্ঠাটি সঠিক বিভাগ পর্যন্ত লোড করা উচিত।

আমার প্রয়োজনীয়তাগুলি chm এর মতো ভয়ঙ্কর লাগে - তারা তা করে they আমি chm বন্ধ আমার প্রয়োজনীয়তা মডেলিং। আমি chm পছন্দ করতে না পারার একমাত্র কারণ হ'ল কোডটি ম্যাপিড এবং অন্যগুলি ব্যবহার করে তার সাথে কীভাবে যোগাযোগ করে। আমি বরং একটি সরল পাঠ্য তালিকা (যা আমার জন্য স্বয়ংক্রিয়ভাবে উত্পন্ন হয়) সঞ্চয় করি যা আমার কোড ডকুমেন্টেশনের প্রসঙ্গে সংবেদনশীল অংশটি অ্যাক্সেস করতে ব্যবহার করতে পারে।

আমি এমন একটি স্ক্রিপ্ট কল্পনা করছি যা এইচটিএমএল আউটপুট ফাইলগুলির মধ্য দিয়ে যাবে এবং একটি সূচক পৃষ্ঠা উত্পন্ন করবে যাতে এটিতে পাওয়া কীওয়ার্ডগুলির একটি তালিকা রয়েছে। স্পষ্টত: শব্দ বর্জন করার মতো শব্দগুলি যেমন: দ্য, এটি, ইত্যাদি ইত্যাদি উপেক্ষা করা উচিত This এই অংশটি লিখতে তুলনামূলক সহজ। দ্বিতীয় অংশে এইচটিএমএল পাঠ্যের মধ্যে কীওয়ার্ডের ডেটাবেস এবং তাদের অবস্থানের একত্রে রাখার জন্য কোনও ধরণের স্ক্রিপ্টের প্রয়োজন হবে। আমি মনে করি এটি ব্রাউজারের মধ্যে অনুসন্ধানের ব্যবস্থা সরবরাহের সাথে সাথে জটিল কাজ হবে।

বিকল্প সম্পর্কিত যে কোনও ধারণা প্রশংসিত হবে। আমি একটি উইকি বা কোনও ওয়েবসারভারে হোস্ট করা স্ট্যাটিক এইচটিএমএল পৃষ্ঠাগুলির সেট ব্যবহার করতে চাই, তবে আমাদের একটি অফলাইন ব্যবহারের প্রয়োজনীয়তা রয়েছে। কেবলমাত্র স্থানীয় ড্রাইভে এইচটিএমএল স্থাপন করা আমাদের প্রয়োজনীয় অনুসন্ধানের প্রয়োজনীয়তা সরবরাহ করে না।

সম্পাদনা করুন:

আমি খনিজ শিল্প দ্বারা ব্যবহৃত সফ্টওয়্যার ডিজাইন। প্রচুর খনি খুব দূরবর্তী এবং কোনও অর্থবহ উপায়ে ইন্টারনেটে অ্যাক্সেস পায় না। পিডিএফ বা এইচটিএমএল বা সিএইচএম নিয়ে কোনও সমস্যা নেই (এটি পুরানো হয়ে চলেছে)) আমি যদি সঠিক স্থানে পিডিএফ ফাইলটি প্রদর্শন করতে পারি (যেমন প্রসঙ্গে সংবেদনশীল সহায়তা) আমি এটি ব্যবহার করব। আমি প্রায় আমার নিজের লিখতে প্রলুব্ধ - মূলত এটি একটি বহনযোগ্য উইকি হবে। এর কথা বললে, আপনি যদি পোর্টেবল উইকির পরামর্শ দেন - আপনাকে শেষ ব্যবহারকারীটির কথা ভাবতে হবে যার এই জাতীয় সরঞ্জামগুলি ব্যবহার করার অভিজ্ঞতা নেই। এটি মৃত সহজ হতে হবে। এটি chm এর সৌন্দর্য ছিল, এটির সাথে কাজ করতে ব্যথা হয় তবে শেষ ব্যবহারকারীরা এটি পছন্দ করেন।


1
বিল্ড অনুসন্ধান মেকানিজমে ব্রাউজারগুলির মতো মানক সরঞ্জাম ব্যবহারে কী ভুল wrong ব্যবহারকারীরা বুঝতে পেরেছেন, এটি আরও যুদ্ধের পরীক্ষা হয়েছে, আপনার কাস্টম অনুসন্ধান পদ্ধতি এবং ইউআই আপনার ব্যবহারকারীদের কাছে আরও বেশি পরিচিত তখন আপনার অনুসন্ধান সিস্টেমটি
রায়নোস

1
@ রেয়নস ব্রাউজার-ভিত্তিক সহায়তা সাধারণত বেশ খারাপ শোনা যায়। ভিএস2010-এ ডিফল্ট সহায়তা সিস্টেম এটির একটি ভাল উদাহরণ।
মেটালমাইকস্টার

উত্তর:


4

আপনি যদি এইচটিএমএল এর পরিবর্তে ডকবুক এক্সএমএল মার্কআপে আপনার সহায়তা লেখার জন্য প্রস্তুত হন তবে ডকবুকের ওয়েবহেল্প উত্পাদন করার জন্য সমর্থন রয়েছে: http://wiki.docbook.org/WebHelp

ওয়েবহেল্প ডকুমেন্টেশনও আউটপুটটির একটি ডেমো: http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html

এটি আপনাকে একটি ওয়েব-ভিত্তিক এইচটিএমএল সহায়তা ফর্ম্যাট দেয় যা এতে অন্তর্ভুক্ত করে:

  • এর সাথে সম্পূর্ণ পাঠ্য অনুসন্ধান:
    • ইংরেজি, ফরাসি এবং জার্মানদের জন্য স্টেমিং সমর্থন। স্টেমার প্রয়োগের মাধ্যমে অন্যান্য ভাষার জন্য স্টেমিং সমর্থন যুক্ত করা যেতে পারে।
    • লুসিন অনুসন্ধান ইঞ্জিন থেকে কোড ব্যবহার করে চীনা, জাপানি এবং কোরিয়ানদের জন্য সমর্থন Support
    • অনুসন্ধান হাইলাইটিং যা দেখায় যেখানে শব্দটির জন্য অনুসন্ধান করা হয়েছে ফলাফলগুলিতে প্রদর্শিত হবে।
    • অনুসন্ধানের ফলাফলগুলিতে লক্ষ্যটির সংক্ষিপ্ত বিবরণ অন্তর্ভুক্ত থাকতে পারে।
  • সঙ্কুচিত টিওসি ট্রি সহ সামগ্রীর সারণী ফলক।
  • সামগ্রীর ফলক এবং টিওসি-র স্ব-সিঙ্ক্রোনাইজেশন।
  • কোনও ফ্রেমসেট ব্যবহার না করে TOC এবং অনুসন্ধান ফলক প্রয়োগ করা হয়েছে।
  • আউটপুট উত্পন্ন করার জন্য একটি পিঁপড়ির বিল্ড.এক্সএমএল ফাইল।

1
এটি আসকিডোক মূলত যা করে।
ব্লুবিল

4

রোবহেল্পের নির্মাতারা অন্যান্য জিনিসগুলিতে গিয়েছিলেন এবং আরও ভাল বিকল্পের জন্য ফিরে এসেছেন। পরীক্ষা করে দেখুন খেপা এর বিস্তারণ - এটা, আউটপুট ফরম্যাটের বিভিন্ন সমর্থন একটি সূচক ও সরবরাহ একটি সার্চ ফাংশন যা স্থানীয়ভাবে পরিচালনা (জাভাস্ক্রিপ্ট এর মাধ্যমে) তৈরি করে।


2

আমরা অফলাইনে সহায়তা ডকুমেন্টেশনের বিভিন্ন স্টাইল তৈরি করতে অ্যাডোব রোবহেল্প ব্যবহার করে যাচ্ছি । এটি সামগ্রীর জন্য অনেক আউটপুট এবং সংহতকরণ বিকল্প সরবরাহ করে। এই সরঞ্জামটির দুর্দান্ত জিনিসটি হ'ল আপনি এটি অ বিকাশকারীদের কাছে হস্তান্তর করতে পারেন এবং অল্প চেষ্টা করে দুর্দান্ত সমাধান আপনার সমাধানের সাথে সংহত করতে পারেন।


1

সিএইচএম নিজেই বুড়ো হয়ে যাচ্ছেন, এবং মাইক্রোসফ্টও নতুন জিনিসগুলির দিকে এগিয়ে গেছে: http://msdn.microsoft.com/en-us/library/bb164608(v=vs.80).aspx

তবে আপনি যদি সত্যিই আপনার সহায়তাটিকে একটি বিদ্যমান সিস্টেমে রূপান্তর করা এড়াতে চান এবং স্থিতি সহায়তা ফাইলে কীভাবে অনুসন্ধান এবং কীওয়ার্ড-লুকআপ সরবরাহ করতে চান তা এখানে দুটি ধারণা:

  • ডকুমেন্টেশন সহ একটি ওয়েবসাইট পরিবেশন করতে প্রকল্পে একটি ছোট লোকালহোস্ট-কেবলমাত্র HTTP সার্ভার যুক্ত করুন। সমস্যাগুলি হ'ল কখন বা কীভাবে এই HTTP সার্ভারটি শুরু / বন্ধ করতে হবে এবং / অথবা এটিকে চালিয়ে রাখা যায়। একটি বিকল্প কাস্টম ইউআরএল স্কিম বাস্তবায়ন করবে, তবে এটি আপনাকে একটি ব্রাউজারে বেঁধে রাখবে এবং এটি আরও অনেক কাজ ( এবং আমি বলতে পারি )

  • একটি জাভাস্ক্রিপ্ট অনুসন্ধান ইঞ্জিন লিখুন। যে কোনও ব্রাউজারে জাভাস্ক্রিপ্ট আজকাল বেশ দ্রুত এবং পারফরম্যান্ট পাচ্ছে। একটি কীওয়ার্ড সূচক সহজেই JSON এ সংরক্ষণ করা যেতে পারে এবং আমি খুব ভাল ফলাফল সহ স্থানীয় ফাইলগুলিতে নিয়মিত এক্সপ্রেসন চালিয়েছি।


আমি একটি জাভাস্ক্রিপ্ট অনুসন্ধান ইঞ্জিনের লাইন ধরে ভাবছিলাম। আমাকে আরও কিছু গবেষণা করতে হবে।
ব্লুবিল

0

আমি যা খুঁজছি তা হ'ল এমন একটি যা অফ-লাইন ব্যবহার করা যায় (এটি গুরুত্বপূর্ণ কারণ আমাদের বেশ কয়েকটি ব্যবহারকারী খুব দূরবর্তী স্থানে রয়েছেন) আমাদের সফ্টওয়্যার সহ।

আমরা আমার সংস্থায় রবহেল্প ব্যবহার করি এবং আমাদের ভাগ্যবান হ'ল সহায়তা ফাইলগুলি অফলাইনে উপলব্ধ করা যায় কারণ আমাদের ব্যবহারকারীরা প্রায়শই এমন অঞ্চল থেকে নেটওয়ার্ক অ্যাক্সেসবিহীন অঞ্চলে যাচ্ছেন।

এটি অনুসন্ধানযোগ্য হওয়া উচিত এবং এর মধ্যে এমন একটি ব্যবস্থা থাকা উচিত যা নির্দিষ্ট এন্ট্রিগুলিকে কল করার অনুমতি দেয়

আমরা স্ক্রিনে কিছু নির্দিষ্ট ক্ষেত্রের ব্যাখ্যার জন্য রবহেল্পে কয়েকটি পৃষ্ঠা ব্যবহার করি। ক্লিকের পরে প্রদর্শিত ক্ষেত্রগুলির জন্য আমরা পপ-আপ রাখতে সক্ষম হয়েছি। রোবহেল্পে খুব ভাল অনুসন্ধানের ক্ষমতা এবং স্বয়ংক্রিয় উত্পন্ন সূচকও রয়েছে। আমি এটির সাথে সর্বদা সন্ধানের সৌভাগ্য অর্জন করেছি। এটি আপনার পক্ষে বিশাল উদ্বেগের বিষয় নাও হতে পারে তবে আমরা ডকুমেন্টেশনটি আপডেট করতে সক্ষম হলাম কারন রোবহেল্প ব্যবহার করা মোটামুটি সহজ প্রোগ্রাম।

আমাদের সাইট ব্যবহার করে, আপনি স্বীকার করেছেন যে আপনি আমাদের কুকি নীতি এবং গোপনীয়তা নীতিটি পড়েছেন এবং বুঝতে পেরেছেন ।
Licensed under cc by-sa 3.0 with attribution required.