Sandcastle (dasturiy ta'minot) - Sandcastle (software)

Sandcastle
Tuzuvchi (lar)	Microsoft
Dastlabki chiqarilish	2006; 14 yil oldin
Barqaror chiqish	2.6.10621.1 / 2010 yil 23-iyun; 10 yil oldin
Ombor	github.com/ EWSoftware/ SHFB
Yozilgan	C #
Operatsion tizim	Microsoft Windows
Platforma	.NET Framework
Turi	Hujjatlar generatori
Litsenziya	Microsoft ommaviy litsenziyasi
Veb-sayt	github.com/ EWSoftware/ SHFB

Sandcastle a hujjatlar generatori dan Microsoft. U avtomatik ravishda ishlab chiqaradi MSDN -stil kodi hujjatlari tashqarida aks ettirish haqida ma'lumot .NET yig'ilishlari va XML hujjat sharhlari manba kodi ushbu yig'ilishlarning. U ishlab chiqarish uchun ham ishlatilishi mumkin foydalanuvchi hujjatlari dan Microsoft Assistance Markup tili (MAML) mos yozuvlar hujjatlari bilan bir xil ko'rinishga ega.

Umumiy nuqtai

Sandcastle - bu to'plam buyruq satri dasturlar, konfiguratsiya fayllari, tarkibiy qismlar va XSLT aylantirish uchun birgalikda ishlaydigan fayllar XML - yordam tizimida ko'rish uchun mos bo'lgan yordam mavzulariga asoslangan hujjatlar. Sandcastle odatda veb-tayyor, XML-mos avtomatik ravishda yaratish uchun ishlatiladi HTML .NET assemblies va XML hujjatlar fayllari tomonidan o'rnatilgan uchta taqdimot uslublaridan biridagi hujjatlar kompilyatorlar. Olingan HTML fayllari keyinchalik kabi vositalarga kirish sifatida ishlatiladi HTML yordam ustaxonasi tegishli bilan tarqatish uchun kompilyatsiya qilingan yordamni ishlab chiqarish kompyuter dasturi.

Hozirda Sandcastle engil vaznga ega grafik foydalanuvchi interfeysi Ga muqobil ravishda (GUI) MSBuild loyiha, ommaviy skript va Windows PowerShell shuningdek taqdim etilgan skriptlar. Sandcastle uchun qo'shimcha funktsiyalarni taqdim etadigan va ulardan foydalanishni soddalashtiradigan bir nechta GUI vositalari mavjud.^[1]

The Visual Studio SDKlar 2005 va 2008 yillarda Sandcastle-ning eski CTP versiyalarini o'z ichiga oladi,^[2] so'nggi versiyasi mavjud bo'lsa-da GitHub.

Sandcastle vositalari

Sandcastle bir nechta dasturlardan iborat bo'lib, ularning hammasi odatiy yordam qurish jarayonida foydalanilmaydi. Odatda ishlatiladigan asboblar quyida keltirilgan.

MrefBuilder foydalanadi Umumiy kompilyator infratuzilmasi (SSP) boshqariladigan yig'ilishlarga qarshi aks etish va chiqish faylini yaratish uchun.
XslTransform XSL formatidagi o'zgartirishlarni XML fayliga qo'llaydi. Odatda, ko'rsatilgan kirish fayli MRefBuilder tomonidan yaratilgan fayldan yoki undan kelib chiqadi.
BuildAssembler, XML manifestida belgilangan har bir mavzu uchun bir marta, tarkibiy qismlar to'plamini bajaradi. Qurilish komponentlari to'plami .config kengaytmasi bo'lgan XML faylida aniqlanadi. Sandcastle ma'lumotlar yig'indisida ma'lumotlar indekslarini yaratish, havolalarni hal qilish, shu jumladan umumiy tarkibni, XSL konvertatsiyalarini bajarish va yakuniy chiqishni faylga saqlash kabi vazifalarni bajarish uchun tarkibiy qismlar to'plamida ishlatiladigan bir nechta qurilish komponentlarini taqdim etadi.

Jamiyat vositalari

Sandcastle-ning hozirgi holatida o'zi juda murakkab bo'lganligi sababli, odamlar ular uchun vazifani avtomatlashtiradigan vositalar va skriptlarni taklif qilishdi. Ushbu bo'limda bunday vositalar va skriptlar ro'yxati mavjud.

Chiqish

Sandcastle tanlangan taqdimot uslubida XML asosidagi HTML-fayllarni ishlab chiqaradi. (Ammo bu fayllar degani emas XHTML -muvofiq.) HTML ishlatilayotgan taqdimot uslubiga kiritilgan XSL formatidagi fayllar bilan belgilanadi. Qurilish odatda bir vaqtning o'zida faqat bitta taqdimot uslubidan foydalanadi.

Sandcastle tomonidan ishlab chiqarilgan HTML-fayllar kontseptual (foydalanuvchi) hujjat bo'lib, bu transformatsiyaning natijasidir Microsoft Assistance Markup tili (MAML) mavzulari yoki ular mos yozuvlar hujjatlari bo'lib, ular avtomatik ravishda aks ettirish ma'lumotlari va XML hujjatlari sharhlaridan hosil bo'ladi. Ushbu ikki xil HTML chiqishi bir xil taqdimot uslubiga ega va ular bilan birgalikda foydalanuvchi / ma'lumotnoma hujjatlarini ishlab chiqarish uchun to'planishi mumkin.

Kontseptual hujjatlar va ma'lumotnoma hujjatlarini yaratish jarayonlari o'xshashdir, ularning asosiy farqlaridan biri shundaki, kontseptual hujjatlar MRefBuilder dasturidan foydalanishni talab qilmaydi.

Kontseptual hujjatlar MAML hujjat turi sxemasi yordamida yozilgan mavzulardan iborat, masalan, qanday bajarish, yurish, muammolarni bartaraf etish va boshqalar. Sandcastle umumiy tarkib va havolalarni hal qiladigan va MAML elementlarini HTML ga aylantirish uchun XSL fayllaridan foydalanadigan kontseptual qurilish komponentlari to'plamini (conceptual.config) taqdim etadi.

Malumot hujjatlari boshqarish uchun avtomatik ravishda tuziladi Ilova dasturlash interfeyslari (API) aks ettirish ma'lumotlari va XML hujjatlari sharhlaridan. Yaratiladigan fayllarni aniqlash uchun tanlangan taqdimot uslubi bilan ta'minlangan "doc model" XSL transformatsiyasi qo'llaniladi. Sandcastle ma'lumotlarning xotiradagi indekslarini tuzadigan, umumiy tarkib va havolalarni hal qiladigan va yakuniy HTML natijalarini yaratish uchun XSL-dan foydalanadigan mos yozuvlar yaratish komponentlari to'plamini (sandcastle.config) taqdim etadi.

Tuzilgan yordam

Sandcastle kompilyatsiya qilingan yordamni o'zi ishlab chiqarmaydi (garchi u ishlab chiqaradigan HTML fayllari HTML yordam kompilyatorlariga kirish sifatida ishlatilishi mumkin) HTML yordam ustaxonasi va Microsoft yordami 2 ).

Masalan, odatiy Help 1.x yaratish jarayoni MrefBuilder.exe-ni ishga tushirish orqali bir yoki bir nechta yig'ilish uchun XML aks ettirish faylini yaratish bilan boshlanadi. So'ngra, aks ettirish fayli XslTransform.exe vositasi tomonidan bir necha marta qayta ishlanib, "doc modeli" va ixtiyoriy versiya ma'lumotlari kabi ma'lumotlarni qo'shadigan turli xil XSL konvertatsiyalarini qo'llaydi. Keyinchalik, XML-ga asoslangan mavzu manifesti aks ettirilgan ma'lumotlar va XML hujjatlari sharhlaridan HTML mavzu fayllarini yaratadigan BuildAssembler.exe dasturi tomonidan yaratiladi va foydalaniladi. XML-ga asoslangan Mundarija (TOC) fayli CHMBuilder.exe tomonidan va BuildAssembler tomonidan ishlab chiqarilgan HTML fayllari bilan birgalikda yaratiladi va foydalaniladi. HTML yordam ustaxonasi loyiha, indeks va TOC fayllari. Nihoyat, HTML yordam seminari kompilyatsiya qilingan yordam faylini (.chm) yaratish uchun ishlatiladi.

Ba'zi vositalar XslTransform va BuildAssembler singari bitta qurilish paytida bir necha marta ishlatiladi. Talablarga qarab, boshqa vositalar va XSL konvertatsiyalari Sandcastle natijalarini o'zgartirish uchun jarayonning turli bosqichlarida ishlatilishi mumkin.

Fon

Sandcastle dasturi tomonidan ishlab chiqilgan Microsoft ölçeklenebilir va ijro etuvchi yaratish hujjatlar generatori ular uchun API hujjatlar. Microsoft Sandcastle-ni jamoat texnologiyasini oldindan ko'rish sifatida chiqardi (CTP ) versiyasi 2006 yil iyulda, bir necha kun oldin NDoc vafot etgan deb e'lon qilindi ^[3]^[4] NDoc muallifi Kevin Dauns o'zining elektron pochtasi orqali yuborilgan elektron pochta xabarida o'zining ommabop vositasini ishlab chiqarishni to'xtatish sabablarini ham moliyaviy, ham taraqqiyot hissasi sifatida avtomatlashtirilgan jamoatchilik tomonidan qo'llab-quvvatlanmaganligi sababli keltirib o'tdi. pochta bombasi uning ommaviy elektron pochta manzili va NDoc2 pochta ro'yxati manziliga hujum qilish, shuningdek, Sandcastle "amalda standartga aylanadi va NDoc asta-sekin turg'un suvga aylanadi" degan taassurot qoldirdi.

Sandcastle kuniga o'rtacha 217 marta yuklab olingan ^[5] 2010 yil sentyabr oyida uni eng ko'p yuklab olingan 25 ta eng yaxshi loyihalardan biriga aylantirdi CodePlex.

2008 yil 6-iyunda SandCastle loyihasi CodePlex veb-saytidan olib tashlandi^[6] CodePlex saytidagi munozarali mavzudan so'ng, manba kodi mavjud emasligini ko'rsatdi; CodePlex-ni talab qilishiga qaramay va SandCastle loyihasi "ochiq manba" sifatida tan olingan.^[7] 2 iyul kuni loyiha CodePlex-ga qaytdi va manba kodi nashr etildi.^[8]

Tarix

2006 yil 29-iyul - 2006-yil iyulda CTP versiyasi chiqarildi, ushbu versiya asosan ishlash va ko'lamini kengaytirishga qaratilgan. Yo'q GUI hali mavjud edi, dasturda hal qilish xususiyati yo'q edi GAC DLL-lar hali.
2006 yil 28 avgust - 2006 yil avgustda CTP versiyasi chiqarildi, ushbu versiyada tuzatilgan xatolar birinchi navbatda dasturning ishdan chiqishini tuzatish uchun ko'rinadi. HTML dasturning chiqishi endi mos keladi Firefox. Buyruqlar satri interfeysiga ba'zi o'zgarishlar kiritildi.
2006 yil 1 oktyabr - 2006 yil sentyabrdagi CTP versiyasi chiqarildi, xatolarni tuzatish birinchi navbatda chiqindagi xatolarni tuzatishga va ba'zilari uchun yaxshiroq yordam qo'shishga qaratilganga o'xshaydi XML izoh teglari.
2006 yil 11-noyabr - 2006-yil noyabrda CTP versiyasi chiqarildi va xatolarni tuzatish bilan bir qatorda qo'llab-quvvatlanadigan boshqa narsalar ham bir nechta nDoc teglar, shuningdek qo'llab-quvvatlashni o'zgartiradi Firefox.
2006 yil 10-dekabr - 2006 yil dekabrdagi CTP versiyasi chiqarildi, unda konfiguratsiya fayllari tomonidan ishlatiladigan DXROOT muhit o'zgaruvchisi, API "ripping" xususiyati, HTML orqali o'tish va taqdimot yangilanishlari ta'minlandi Firefox VS 2005 uslubida.
2007 yil 6 mart - 2007 yil mart oyidagi CTP versiyasi chiqarildi, unga 4 ta yangi qo'shildi va 3 ta XSL konvertatsiyasi olib tashlandi, ommaviy skript va ishlash yaxshilandi.
2007 yil 17 mart - 2007 yil mart oyida CTP-ni texnik yangilash versiyasi chiqarildi, u "yirtilib ketish" xususiyati va yordamchi dastur xatolarini tuzatdi, shuningdek ilgari chiqarilgan o'rnatuvchida etishmayotgan faylni tuzatdi.
2007 yil 19 iyun - 2007 yil iyun oyida CTP versiyasi chiqdi MSBuild loyihasi, ning yangi versiyasi Umumiy kompilyator infratuzilmasi (SSP) aks ettirish mexanizmi, yangi taqdimot uslubi, "VS ORCAS ", yangi qurilish komponenti, yangi bajariladigan yordam dasturlari va boshqa bir qator yaxshilanishlar.
2007 yil 27 iyun - 2007 yil iyun oyida ilgari chiqarilgan "VS" deb nomlangan CTP Refresh versiyasi chiqarildi ORCAS "Orcas Beta 2 va RTM hujjatlari yuborilganidan beri chalkashliklarni oldini olish uchun" Hana "ga taqdimot uslubi MSDN VS 2005 taqdimot uslubida qurishni davom ettirmoqchi edi.
2007 yil 1 oktyabr - 2007 yil sentyabr oyida CTP versiyasi chiqarildi, birinchi bo'lib CHMBuilder, VersionBuilder va DBCSFix vositalari paydo bo'ldi, Windows PowerShell skriptni yaratish, taqdimot uslubini yangilash (ayniqsa, VS 2005 uslubiga tegishli) va .NET Framework odatda oldingi o'rnatuvchilarga kiritilgan aks ettirish fayllari.
2007 yil 30 oktyabr - 2007 yil oktyabr oyida CTP versiyasi chiqarildi, shu jumladan .NET Framework oldingi versiyada etishmayotgan fayllar, yangi kontseptual hujjatlarni yaratish jarayoni talab etiladi Microsoft Assistance Markup tili (MAML) mavzulari kirish sifatida, shuningdek yaxshilandi Firefox qo'llab-quvvatlash.
2008 yil 16-yanvar - Sandcastle 2.4.10115 versiyasi chiqarildi, bu Sandcastle-ning veb-saytiga (RTW) chiqarilgan birinchi rasmiy bo'lmagan CTP versiyasi edi. Grafik interfeysining (GUI) namunasi, shu jumladan Script # uchun XSL transformatsiyasi va ASP.NET veb-sayt.

Shuningdek qarang

Hujjatlar generatorlarini taqqoslash

Adabiyotlar

^ Sandcastle yordami
^ Sandcastle-ni e'lon qilish: Sandcastle blogi
^ Sandcastle - NDoc o'limining dumlari bo'yicha Help CHM fayl generatorining Microsoft CTP
^ NDoc 2 rasmiy ravishda o'likdir
^ Sandcastle statistikasi
^ Sandcastle loyihasi Codeplex-dan o'chirildi
^ "Sandcastle" ochiq manba "?". Olingan 2008-07-02.
^ "Sandcastle Source Code Codeplex-da chop etildi". 2008-07-02. Olingan 2008-07-02.

Tashqi havolalar

Rasmiy veb-sayt

[1] Sandcastle yordami

[2] Sandcastle-ni e'lon qilish: Sandcastle blogi

[3] Sandcastle - NDoc o'limining dumlari bo'yicha Help CHM fayl generatorining Microsoft CTP

[4] NDoc 2 rasmiy ravishda o'likdir

[5] Sandcastle statistikasi

[6] Sandcastle loyihasi Codeplex-dan o'chirildi

[7] "Sandcastle" ochiq manba "?". Olingan 2008-07-02.

[8] "Sandcastle Source Code Codeplex-da chop etildi". 2008-07-02. Olingan 2008-07-02.

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]