MODX क्रांति के लिए खुला स्रोत प्रलेखन

मैं आपको MODX क्रांति के लिए एक नई खुली प्रलेखन परियोजना पेश करना चाहता हूं।

क्यों?

फिर, यह प्रणाली नए से बहुत दूर है, लेकिन रूसी भाषा का सामान्य प्रलेखन अभी भी नहीं है। सब कुछ जो विभिन्न समुदायों और ब्लॉगों में बिखरा हुआ है, जिनमें से कई दर्जन हैं, और कोई भी नौसिखिया उपयोगकर्ता सवाल पूछने के लिए आगे-पीछे चलता है।

रूसी में आधिकारिक दस्तावेज का रखरखाव नहीं किया जाता है। मुझे नहीं पता कि यह अब कैसे है, लेकिन एक साल पहले वे सिर्फ़ सीरिलिक संरक्षित नहीं करते थे।

N या ​​z पर क्यों नहीं?

क्योंकि इन साइटों में मेजबान हैं, उन्हें उपयोगकर्ता नाम / पासवर्ड मांगने की आवश्यकता है और इस बात की कोई गारंटी नहीं है कि साइट कल Google कैश में आपके योगदान को छोड़कर खो नहीं जाएगी।

उदाहरण के लिए, मैंने आधिकारिक वेबसाइट पर अपने ऐड-ऑन के बारे में लिखने की कोशिश की, और फिर उन्होंने इसे रीड कर लिया, और मेरा लॉगिन पासवर्ड अब फिट नहीं हुआ। पंजीकरण करना असंभव है - आपको उन्हें समर्थन पत्र के माध्यम से प्राप्त करने की आवश्यकता है। बेशक, फिर से ऐसा करने की कोई इच्छा नहीं है।

इसके अलावा, MODX समुदाय सामंजस्य का दावा नहीं कर सकता है, और मुख्य डेवलपर्स को वहां कुछ लिखने के लिए बस एक जगह इकट्ठा नहीं किया जा सकता है।

और आप क्या सुझाव देते हैं?

बहुत सरल - आपको प्रसिद्ध मार्कडाउन प्रारूप में गिटहब पर प्रलेखन बनाए रखने की आवश्यकता है।

ऐसी प्रणाली हमें गारंटी देती है:

• सभी ग्रंथों की सुरक्षा । हर कोई रिपॉजिटरी को कॉपी करके होस्ट कर सकता है।
• इतिहास को बदलो । सभी दृश्य पूर्ण रूप से संपादित होते हैं, यह स्पष्ट है कि किसने क्या लिखा है।
• स्वतंत्रता । आप किसी भी भाषा में MODX से संबंधित किसी भी विषय के बारे में लिख सकते हैं। और आपको इसके लिए एक्सेस मांगने की आवश्यकता नहीं है - बस एक खाता है GitHub पर।

विचार नया नहीं है, और मैंने इसे daux.io परियोजना पर जासूसी की। यह एक PHP स्क्रिप्ट है जो रेडीमेड मार्कडाउन फ़ाइलों का उपयोग करके एक साइट बनाता है।
यह बहुत सरल है, और आपको किसी भी होस्टिंग पर, बिना किसी कौशल के, प्रलेखन के साथ अपनी वेबसाइट चलाने की अनुमति देता है। हालांकि, मेरी राय में, इसमें कई कमियां हैं (जो कि फायदे की निरंतरता हैं)।

उदाहरण के लिए, मैं बिलकुल नहीं हूँ कि कैशिंग के बिना, डायनामिक रूप से फ़ाइल द्वारा साइट बनाना, कई हज़ार पृष्ठों पर अच्छा काम करेगा। इसके अलावा, कोई खोज नहीं है, पृष्ठ के पते का कोई प्रबंधन नहीं है, भाषा संस्करणों के बीच सुविधाजनक स्विचिंग, और यहां तक ​​कि छोटी चीजें भी हैं।

इसलिए, हमारे प्रलेखन को दिखाने के लिए, मैंने अपने पसंदीदा सिस्टम - MODX का उपयोग किया।

यह कैसे काम करता है?

यह एक नियमित MODX वेबसाइट है जिसे मानक ऐड-ऑन का उपयोग करके बनाया गया है, लेकिन इसके सभी पृष्ठ फाइलों से आयात किए जाते हैं।

यह देता है:

• भंडारित करता है। सभी दस्तावेज़ कैश से डाउनलोड किए जाएंगे, और आपको हर बार एचडीडी पर फ़ाइलों को ऊनी करने की आवश्यकता नहीं है।
• दस्तावेज़ों का url प्रबंधित करें - उन्हें खोज इंजन से नेविगेशन खोए बिना स्थानांतरित किया जा सकता है।
• साइट पर एक खोज को व्यवस्थित करने की क्षमता।
• भाषा संस्करणों के साथ सुविधाजनक काम, वे किसी भी संख्या में हो सकते हैं।
• क्षमता, भविष्य में, साइट पर प्राधिकरण (हाइब्रिडऑथ) और टिप्पणियों (टिकट) को सक्षम करने के लिए।

साइट ट्री में केवल दस्तावेज हैं।


मैं तालिका की प्रारंभिक सफाई के साथ पेड़ के पूर्ण अद्यतन की संभावना रखना चाहता हूं, इसलिए मैं मक्खी पर सेवा पृष्ठ उत्पन्न करता हूं और उन्हें डेटाबेस में सहेजता नहीं हूं। यह एक नई धारणा है, आइए देखें कि यह कैसे काम करेगा।

उदाहरण के लिए, एक साइट का नक्शा इस तरह जारी किया जाता है:

<?php if ($modx->event->name != 'OnHandleRequest' || $modx->context->get('key') == 'mgr') {return;} $alias = $modx->getOption('request_param_alias', null, 'alias'); $request = strtolower($_REQUEST[$alias]); if ($request == 'sitemap.xml') { $output = $modx->runSnippet('pdoSitemap', array('context' => 'web,en')); exit($output); } 

और यहाँ खोज पृष्ठ हैं:

 elseif ($request == 'search') { $doc = $modx->newObject('modResource'); $doc->fromArray(array( 'id' => 100000000, 'context_key' => $modx->context->key, 'pagetitle' => $modx->context->key == 'en' ? 'Search' : '', 'template' => 3, 'content' => ' [[!pdoPage@Search?context=`'.$modx->context->key.'`]] [[+page.nav]] ' )); $modx->resource = $doc; $response = $modx->getResponse(); $output = $modx->response->outputContent(); exit($output); } 

यही है, कार्य प्लगइन के माध्यम से ऑनहैंडल रीसेंट इवेंट में जाता है और संदर्भ (भाषा संस्करण) पर निर्भर करता है।

मैंने फोन और टैबलेट से पढ़ने के लिए आरामदायक बनाने के लिए बूटस्ट्रैप 3 पर लेआउट को स्केच किया। काम के लिए उपयोग किया जाता है:

• pdoTools - आउटपुट पड़ोसी दस्तावेज़, सभी मेनू और ब्रेडक्रंब।
• mSearch2 - रूपात्मक खोज।
• DateAgo - अच्छा दिनांक स्वरूपण
• yTranslit - यैंडेक्स अनुवाद के माध्यम से यूआरएल पृष्ठों की पीढ़ी।
• MinifyX - तेज पृष्ठ लोडिंग के लिए स्क्रिप्ट और शैलियों को gluing और संपीड़ित करना।
• इस प्रारूप में ग्रंथों के आउटपुट के लिए मार्कडाउन एक नया स्निपेट है। इस परियोजना के लिए विशेष रूप से लिखा।

मैं आपको एक बार फिर याद दिलाता हूं कि यह दस्तावेज किसी का नहीं है । मैंने इसके आउटपुट के लिए साइट का अपना संस्करण बनाया है, और आप रिपॉजिटरी को क्लोन कर सकते हैं और इसे उसी daux.io पर चला सकते हैं - निर्देशिका और फ़ाइल संरचना संगत है।

परियोजना का लक्ष्य अंत में समुदाय को एक स्थान पर सभी जानकारी एकत्र करने और इसे एक साथ उपयोग करने के लिए एक उपकरण देना है। अब सम्मिलित हों !

संदर्भ

Gitub प्रलेखन भंडार ।
इस प्रलेखन के समापन के साथ साइट ।

भविष्य की योजनाएं: अन्य साइटों पर ग्रंथों को प्रदर्शित करने के लिए एक सरल एपीआई का विकास और (संभवतः) यूआरएल शोर्टनर।

01.15.2014 अपडेट किया गया

डोमेन नाम के साथ असंतोष के कारण, दस्तावेज़ को docs.modx.pro में स्थानांतरित कर दिया गया था।

मुझे उम्मीद है कि आगे कोई आपत्ति नहीं होगी।