WinHelp форматы: тарихы, қолданылуы және тоқтатылуы

Кіріспе

Файл пішімі

Microsoft WinHelp – Microsoft Help браузері winhelp.exe немесе winhlp32.exe арқылы көрсетілуі мүмкін онлайн көмек файлдарының авторлық құқықпен қорғалған пішімі. Файл пішімі Rich Text Format (RTF) негізінде құрылған. Ол Windows 3.0-ден Windows XP-ге дейін танымал көмек платформасы болып келді. WinHelp Windows Vista жүйесінде бағдарламалық жасақтаманы жасаушыларды қолданыстан қалған форматты пайданудан ауыстыру және жаңа көмек форматтарын қолдануға ынталандыру үшін алынып тасталды. WinHelp файлдарына қолдау Windows 10 жүйесінде толығымен тоқтатылды.

Тарих

1990 – WinHelp 1.0 Windows 3.0-мен бірге жеткізілді. 1995 – WinHelp 4.0 Windows 95 / Windows NT-мен бірге жеткізілді. 2006 – Microsoft WinHelp-ті қолдау көрсетілетін платформа ретінде кезең-кезеңмен тоқтату ниетін жариялады. WinHelp Windows Vista-ның құрамына кірмейді. WinHelp файлдары 16 және 32 биттік түрлерде болады. Vista осы файл түрлерін әртүрлі өңдейді. 32 биттік hlp форматын пайдаланатын қосымшаны іске қосқанда Windows бұл формат енді қолдау көрсетілмейтіні туралы ескертеді. 32 биттік hlp файлдарына арналған қарау құралын Microsoft Download Center-ден жүктеуге болады. 16 биттік WinHelp файлдары Windows Vista-да (тек 32 биттік нұсқасында) қарау құралын жүктемей-ақ көрсетіледі. 2009 жылдың 9 қаңтары – Microsoft Windows Help бағдарламасының (WinHlp32. exe) Windows Server 2008 үшін Microsoft жүктеу орталығында қолбар екенін жариялады. 2009 жылдың 14 қазаны – Microsoft Windows Help бағдарламасының (WinHlp32. exe) Windows 7 және Windows Server 2008 R2 үшін Microsoft жүктеу орталығында қолбар екенін жариялады. 2012 жылдың 26 қазаны – Microsoft Windows Help бағдарламасының (WinHlp32. exe) Windows 8 үшін Microsoft жүктеу орталығында қолбар екенін жариялады. 2013 жылдың 5 қарашасы – Microsoft Windows Help бағдарламасының (WinHlp32. exe) Windows 8.1 үшін Microsoft жүктеу орталығында қолбар екенін жариялады. 2015 жылдың 15 шілдесі – Microsoft Windows 10 жүйесінен Windows Help-ті толыққанды алып тастады. HLP файлын ашуға тырысқанда пайдаланушылар оның алынып тасталғаны туралы ақпаратты көрсететін көмек бетіне бағытталады.

Файл пішімі

WinHelp файлының кеңейтімі ".hlp" болып табылады. Оған көмек әзірлеуші жасаған жағдайда, қосымша мазмұн кестесі (.cnt) файлы да қоса берілуі мүмкін. Windows WinHelp файлын ашқанда, ол сол каталогта немесе "%LOCALAPPDATA%\Help" орнында, терезе өлшемі және орналасуы сияқты hlp файлы туралы ақпаратты қамтитын gid файлын жасайды. Егер пайдаланушы "Іздеу" қойындысын таңдап, кілт сөздерді индекстеуді қосса, Windows fts (толық мәтіндік іздеу) кеңейтімі бар индекс файлын жасайды. Әрбір Windows көмек файлының түсіндірмелері мен белгілемелері ".ann" және ".bmk" кеңейтімдерімен сақталады. Көптеген бағдарламалық құралдар WinHelp файлын бастапқы құжаттарына: HPJ, CNT, RTF, BMP және SHG түрлендіре алады. HPJ файлы – бұл Көмек шеберханасында (немесе үшінші тараптың көмек құралында) құрылатын және өңделетін жоба файлы. HPJ файлы қандай RTF файлдарын көмекке жинау керектігі, шақырушы бағдарламадан көмек файлына сілтемелер беретін MAP ID-лер мен псевдонимдер, сондай-ақ көмек файлының сыртқы түрі (терезе өлшемі, әдепкі батырмалар, түс схемалары және т.б.) туралы ақпаратты қамтиды. CNT файлы көмек файлының мазмұнын ұсынады. SHG файлы – бұл графикалық файлға (мысалы, BMP) көмек шақыруларының бейне картасын құрайтын "SHED" графикалық файлы. Бұл файлдарды оқуға және зерттеуге болатын бірнеше құрал бар. (Мысалы, Help to RTF және winhelpcgi қараңыз.) +WinHelp файлдары туралы қысқаша мәліметтер hlp сипаттама hpj жоба файлы (жайып жазылған мәтін?); hlp файлына жинауға болатын барлық rtf файлдардың тізімін және қосымша ақпаратты қамтиды cnt Мазмұн кестесі (TOC) файлы rtf Rich Text Format форматындағы нақты мәтіндік мазмұн bmp dib wmf shg әртүрлі форматтағы кескіндер: bmp немесе dib, wmf shg fts ftg Толық мәтіндік іздеу; көмек құжаттарының мәтінін іздеу үшін қолданылады ann түсіндірмелермен файл (жайып жазылған мәтін?) bmk белгілемелермен файл (жайып жазылған мәтін?)

Бастапқы файлдар мен құрастыру

HLP файлын құрастыру үшін қажетті бастапқы файлдар Rich Text Format форматындағы бір немесе бірнеше құжаттан және hpj кеңейтімі бар анықтамалық жоба файлынан тұрады. Бұған қоса, анықтамалық файлда қолданылатын кез келген кескін файлдары (.bmp, .wmf немесе .shg) да қажет. HLP файлымен бірге пайдалану үшін cnt кеңейтімі бар мазмұндама кестесін жасау да мүмкін. RTF файлдарындағы тақырыптар бет үзілісімен бөлінеді. Әрбір тақырыпта анықтамалық компиляторы үшін ақпаратты қамтитын әртүрлі түбір жазбалар болады: # түбір жазбалары тақырып идентификаторын (осы тақырыпқа сілтеме жасау үшін қолданылады) қамтиды. $ түбір жазбалары мазмұндама кестесінде, көрсеткіште және басқа да жерлерде тақырыптың атауын көрсетеді. K түбір жазбалары көрсеткіш үшін кілт сөздерді қамтиды. A түбір жазбалары "Қараңыз" кілт сөздерін қамтиды. * түбір жазбалары құрастыру белгілерін қамтиды. + түбір жазбалары шолу тізбегі туралы ақпаратты қамтиды. ! түбір жазбалары тақырыптық макростарды қамтиды. Тек # түбір жазбасы ғана міндетті, ал қалғандары – қосымша. Әрбір тақырыптағы мәтін қалың, курсив және түстерді қамтитын шектеулі форматталу мүмкіндігіне ие. Үстін сызу және астын сызу рұқсат етілмейді. Бір анықтамалық файлдағы тақырыптар арасындағы сілтемелер көбінесе бастапқы құжатта қос сызылған мәтін (әдепкі бойынша жасыл түс, бірақ бұл өзгертілуі мүмкін) және жасырылған мәтінде тақырып идентификаторы түрінде көрінеді. Ашылатын сілтемелер бастапқы құжатта бір сызылған мәтін (әдепкі бойынша жасыл түс) және одан кейін жасырылған мәтінде тақырып идентификаторы түрінде көрінеді. (Анықтамалық файлда сілтемелер бір сызылған жасыл мәтін түрінде, ал ашылатын терезелер нүктелі сызылған жасыл мәтін түрінде көрсетіледі.) Кескіндерді {bmc image.bmp} сияқты кодтарды пайдаланып қосуға болады. Қолдау көрсетілетін кескін форматтарына bmp, wmf және shg (кескін карталары үшін қолданылады, олар кескіннің белгілі бір бөліктерін басу арқылы іске қосылатын сілтемелерді немесе ашылатын терезелерді қамтуы мүмкін) жатады. Бастапқы файлдар құрылғаннан кейін анықтамалық файлды HCW.exe сияқты WinHelp компиляторын пайдаланып немесе RoboHelp немесе HelpBreeze сияқты коммерциялық бағдарламалық қамтамасыз етуді пайдаланып құрастыруға болады. Көптеген бағдарламалар (оның ішінде осы жерде аталған екеуі де) hcw.exe-ді артқы компилятор ретінде пайдаланады.

Source files required to compile a hlp file consist of one or more documents in Rich Text Format and a help project file with the extension hpj, along with any image files (. bmp, wmf, or shg) that are used within the Help file. An optional table of contents file with the extension cnt can also be created for use with the hlp file. Within the rtf files, topics are separated by page breaks. Each topic has a series of footnotes that contain information for the help compiler:
# footnotes contain the topic ID (used to create links to that topic). $ footnotes contain the topic name as it displays in the table of contents, index, and other locations. K footnotes contain keywords for the index. A footnotes contain See Also keywords. * footnotes contain build tags. + footnotes contain browse sequence information. ! footnotes contain topic entry macros. Only the # footnote is required. All others are optional. Text in each topic can contain limited formatting, including bold text, italics, and colors. Superscript and subscript are not allowed. Jumps between topics in the same Help file usually appear in the source document as double underlined text (green by default, though this can be overridden) followed by a topic ID in hidden text. Popup links appear in the source document as text with a single underline (also green by default) followed by a topic ID in hidden text. (In the hlp file, the jumps show up as green text with a single underline, and popups show up as green text with a dotted underline.) Images can be added using codes such as {bmc image. bmp}. Supported image formats include bmp, wmf, and shg (used for image maps, which can contain jumps or popups that are triggered by clicking on specific parts of the image). After the source files have been created, the help file can be compiled using a WinHelp compiler such as HCW. exe or by using a commercial software program such as RoboHelp or HelpBreeze, most of which (included the two cited here) also use hcw. exe as the backend compiler.

WinHelp-тің көрінісі мен ерекшеліктері

Көмектесуші файл қалай іске қосылғандығына және автор қандай параметрлерді таңдағандығына байланысты, WinHelp файлы әдепкі тақырыбында, мазмұнында немесе индексінде ашылады. WinHelp файлындағы тақырып жеке терезеде ашылады, оның мөлшері мен бастапқы орналасуы көмек авторының таңдауымен анықталады. Пайдаланушылар терезенің мөлшерін өзгерте немесе орнын ауыстыра алады. Көмек авторы файлдың сеанстар арасында пайдаланушы параметрлерін сақтайтынын немесе әдепкі мөлшерде және орналасуда ашылатынын бақылай алады. Тақырып ашылғанда, Көмек терезесінің жоғарғы жағындағы тақырып жолағы тақырыптың атауын көрсетеді. Төменде файлдың әртүрлі аспектілерін басқаратын мәзірлер (Файл, Өңдеу, Белгіше, Параметрлер және Көмек) орналасқан. Әдетте мәзірдің астында батырмалар қатары пайда болады. Көмек авторы қандай батырмалардың көрсетілетінін анықтайды. Типик батырмалар: Мазмұн, Индекс, Артқа және Басып шығару, сонымен қатар файлды қарау үшін «<« және «>>» батырмалары бар. Көмек авторлары нақты тақырыптарға жылдам өту немесе басқа әрекеттерді орындау үшін арнайы батырмаларды да құра алады. Батырмалардың астында терезенің негізгі мәтін аймағы орналасқан. Әдетте мәтіннің басы қалың әріппен немесе қалған мәтінге қарағанда үлкен шрифтпен басталады. Бұл тақырып кейде терезеде жылжымайтын аймақта орналасуы мүмкін – терезедегі жылжымалы жолақ арқылы жоғары-төмен жылжымайтын аймақ. Жылжымайтын аймақтарды тек тақырыптың басында ғана пайдалануға болады. Көмек авторы жылжымайтын аймақтың мөлшері мен фондық түсін бақылай алады. Көмек авторлары сондай-ақ тақырыптың нақты мәтіні көрсетілетін негізгі мәтін аймағының фондық түсін де бақылай алады. Бұл мәтінді әртүрлі форматтауға болады. Мәтін ішінде сілтемелер жасыл түспен және бір сызықпен көрсетіледі. Сілтемеге бір рет басу арқылы басқа тақырып ашылады. Кейбір сілтемелер қосымша ақпаратты көрсету үшін қосымша Көмек терезесін ашады. Төменгі сызығы нүктелі жолмен көрсетілген жасыл мәтін түріндегі ашылмалы терезелер мәтінде пайда болады. Ашылмалы терезеге бір рет басу арқылы мәтінге сәйкес келетін кішкентай терезе ашылады, онда мәзірлер, батырмалар немесе жылжымалы жолақтар жоқ. Көп жағдайда ашылмалы терезелер негізгі терминдердің қысқаша анықтамаларын немесе негізгі мәтін туралы қосымша ақпаратты ұсынады. Пайдаланушы келесі рет басса немесе перне басса, ашылмалы терезе автоматты түрде жабылады. Көптеген, бірақ барлық емес Көмек тақырыптары мәтіннің соңында «Қараңыз» сілтемесіне ие. Көмек авторының қалауына байланысты бұл мүмкіндік қарапайым сілтемелер тізімі болуы мүмкін немесе «Қараңыз» тақырыбының астындағы кішкентай батырма болуы мүмкін. Бұл батырмаға басу арқылы барлық қатысты тақырыптарды көрсету үшін диалогтық терезе ашылады. Диалогтағы тақырыптың атын басып, содан кейін «Көрсету» батырмасын басу арқылы сол тақырып ашылады. Көмек файлдарының көпшілігінде пайдаланушыларға ақпаратты табуға көмектесетін мазмұн кестесі мен индекс болады. Бұл бөлек, қойындылы терезеде көрсетіледі. «Мазмұн» қойындысын басу арқылы мазмұн кестесі ашылады, онда пайдаланушылар тақырыптарды көру үшін тақырыптарға баса алады. Көп жағдайда тақырыптар кішкентай кітаптарға ұқсас белгішелермен, ал тақырыптар беттерге ұқсас белгішелермен белгіленеді. Тақырыпты екі рет басу (немесе тақырыпты басып, содан кейін «Көрсету» батырмасын басу) сол тақырыпты ашады. «Индекс» қойындысын басу арқылы индекс ашылады, онда жазу өрісі және әліпби бойынша сөздердің тізімі бар. Жазу өрісіне кілт сөздерді енгізу тізімді ең жақын сәйкестікке автоматты түрде жылдырады. Кілт сөзді екі рет басу (немесе кілт сөзді басып, содан кейін «Көрсету» батырмасын басу) сол кілт сөзбен байланысты тақырыпты (егер тек бір ғана болса) көрсетеді немесе оған байланысты барлық тақырыптардың тізімін ашады. Индекс пайдаланушыларға ақпаратты табуға көмектеседі. Кейде Көмек файлдарында «Іздеу» қойындысы да болады, ол пайдаланушыға файл мәтінінде қолданылған кез келген сөзді іздеуге мүмкіндік береді, тек кілт сөздерді ғана емес. WinHelp сондай-ақ контекстке бейім көмек ретінде белгілі бір мүмкіндікті қолдайды. Контекстке бейім көмек – бұл пайдаланушының бағдарламалық қосымшадағы орналасқан жеріне және олардың не істеуге тырысқанына сәйкес келетін көмек. Қауіпсіздік тұрғысынан маңызды ерекшелік – бұл арнайы кодты қамтитын және оны WinHelp тақырыптарымен байланыстыратын DLL файлын қосу мүмкіндігі. Бұл HLP файлдарын орындалатын файлдарға теңестіреді.

Depending on how it has launched and what settings the Help author chose, a WinHelp file opens either to its default topic, its table of contents, or its index. A topic in a WinHelp file opens in a separate window, in a size and initial position that the Help author may choose. Users can resize or reposition the window. The Help author can control whether the Help file stores the user's settings between sessions, or always opens in the default size and position. When a topic is open, a title bar at the top of the Help window displays the topic title. Below that is a row of menus (File, Edit, Bookmark, Options, and Help), which control various aspects of the file. A row of buttons usually appears below the menus. The Help author controls which buttons, if any, appear. Typical buttons include Contents, Index, Back, and Print, along with << and >> buttons to browse through the file. Help authors can also create custom buttons to jump to specific topics or perform other actions. Below the buttons is the main text area of the window. Typically, the text begins with a heading, often bold or in a larger font than the rest of the text. This heading may sometimes be in a non scrolling region—an area of the window that does not move up or down via the scrollbar at the side of the window. Non scrolling regions can only be used at the beginning of a topic. The Help author can control size and background color of a non scrolling region. Help authors can also control the background color of the main text area, where the actual text of the topic appears. This text can be formatted and arranged in many ways. Within the text, jumps appear as green text with a single underline. Single clicking on a jump opens a different topic. Some jumps may open secondary Help windows to display information. Popups appear in the text as green text with a dotted underline. Single clicking on a popup opens a small window with no menus, buttons, or scrollbars, sized to fit the text. Often, popups provide short definitions of key terms or other supplemental information about the main text. The popup automatically disappears the next time the user clicks or presses a key. Many, though not all Help topics have See Also jumps at the end of the text. Depending on the Help author's preference, this feature may be a simple list of jumps under the heading See Also, or it may be a small button that, when clicked, brings up a dialog box displaying all the relevant topics. Clicking on the name of a topic in that dialog box then clicking Display opens that topic. Most Help files also contain a table of contents and an index to help users locate information. These appear in a separate, tabbed window. Clicking on the Contents tab opens the table of contents, in which users can click on headings to see the topics. Often, headings are marked with icons that look like small books and the topics have icons that look like pages. Double clicking on a topic (or clicking on a topic then clicking Display) opens that topic. Clicking on the Index tab opens the index, which has a typing field and an alphabetical keyword list. Typing in the typing field automatically scrolls the list of keywords to the closest match. Double clicking on a keyword (or clicking on a keyword then clicking Display) displays the topic associated with that keyword (if only one) or brings up a list of all topics associated with it. The index is important in helping users locate information. Sometimes Help files also have a Find tab, which lets the user search for any word used in the text of the file, not just for keywords. WinHelp also supports a feature known as context sensitive help. Context sensitive help is assistance that is appropriate to where the user is in the software application, and what they are trying to do. A rather security critical feature is that one can also include a DLL file containing custom code and associating it with WinHelp topics. Effectively this makes HLP files equivalent to executables.

Қосымша қолдаудың аяқталуы

2006 жылғы WritersUA конференциясында Microsoft WinHelp-ті қолдау көрсетілетін платформа ретінде кезең-кезеңмен тоқтату ниетін жариялады. Тед Дворкин (WinHelp тәжірибесінің серіктес директоры) «WinHelp Vista үшін белгіленген код стандарттарына сай келмейді. Бұл стандарттар қауіпсіздік, сенімділік және өнімділікті қамтиды» деді. Ол WinHelp-ті «Vista код стандарттарына сай болу үшін оны бастапқы кодтан толығымен қайта жазуымызға тура келеді. Бірақ Vista-да тағы екі көмек жүйесі бар екенін ескерсек, мұндай тәсілдің мәні жоқ» деп түсіндірді. Жаңартылған лицензиялық келісім қолданба дамытушыларға WinHelp кітапханаларын өз орнатушыларымен бірге қосуға тыйым салады. Бұл, Windows Vista (немесе одан жоғары нұсқасы) жаңадан орнатылғанда, ескі қолданбаларға арналған WinHelp нұсқаулықтарын оқу мүмкін емес екенін білдіреді. Оларды оқу үшін соңғы пайдаланушы Microsoft веб-сайтынан 32 биттік WinHelp қарау құралын жүктеп алып, қолмен орнатуы керек. Windows 10 және одан кейінгі нұсқаларында Microsoft операциялық жүйе үшін WinHelp қарау құралын ұсынбайды. Microsoft-тың ресми жүктеліп алынатын компонентін пайдаланып WinHelp файлдарын ашып оқуға болатын Windows-тың соңғы нұсқасы Windows 8.1 болып табылады. Wine-дың ашық кодты winhlp32 нұсқасы Windows 10-да да жұмыс істейді. Ол WineVDM құрамына кіреді. Сондай-ақ, Windows 10-да WinHelp ескі Windows нұсқаларынан алынған winhlp32.exe файлымен де жұмыс істейді.

Басқа құжаттамалық файл пішімдері

Құжаттама WinHelp сияқты нақты өндірушінің форматталу түрінде толығымен сақталуы мүмкін болғанымен, көбінесе құжаттама бірден бірнеше форматта жариялануы тиіс: Microsoft Compiled HTML Help (CHM), WinHelp, HTML беттері, Java Help, PDF және т.б. Әр форматты жеке-жеке күтіп ұстау өте қымбатқа түсіп, қателерге әкелуі мүмкін. Сондықтан авторлар әдетте құжаттаманы DocBook немесе FrameMaker сияқты өнеркәсіптік стандартты, өндірушіге тәуелсіз авторлық форматта сақтайды, оның көмегімен бірнеше түрлі форматталу түрін (WinHelp-ті қоса) жасауға болады. Осылай өндірілген әртүрлі форматталған файлдар (WinHelp немесе басқа құралдар арқылы) бірдей мазмұнға ие болады, себебі олардың барлығы бір көзден жасалған.