You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by db...@apache.org on 2015/07/24 00:21:08 UTC
[64/75] docs commit: Moved tools to tools/ and added some tools for
new doc pipeline.
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/fr/README.md
----------------------------------------------------------------------
diff --git a/doc/fr/README.md b/doc/fr/README.md
deleted file mode 100644
index dd3f8a9..0000000
--- a/doc/fr/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# Apache Cordova API Documentation
-
-La documentation de l'API JavaScript pour [Apache Cordova](http://cordova.io/).
-
-La documentation est disponible à [docs.cordova.io](http://docs.cordova.io/).
-
-## Format de documentation
-
-Toute la documentation [Apache Cordova](http://cordova.io/) est écrit avec [markdown](http://daringfireball.net/projects/markdown/syntax), un langage de balisage léger qui peut être composé au format HTML. Markdown offre un moyen simple et flexible pour documenter le noyau de Cordova API et API spécifique à la plateforme.
-
-## Structure des fichiers
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## Contribuer à la Documentation
-
-### Rapport ou résoudre un problème
-
-Nous utilisons [JIRA Apache](https://issues.apache.org/jira/browse/CB)
-
-Par ailleurs, vous bercer ! Merci de nous aider à améliorer la documentation !
-
-### À l'aide de Git
-
-Vous êtes nouveau sur Git ou contribuer sur GitHub ?
-
-Nous avons [écrit quelques Git tutoriaux](http://wiki.apache.org/cordova/ContributorWorkflow) pour vous aider à commencer à contribuer à la documentation.
-
-### Envoyer des demandes de Pull
-
-Requêtes d'extraction sont les bienvenus !
-
-Nous apprécions l'utilisation des branches du sujet.
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### Ajout d'une langue
-
-Voulez-vous la documentation Apache Cordova, dans une autre langue ? Nous faisons aussi ! Avec le soutien de la plateforme de gestion de [Crowdin](http://crowdin.net/project/cordova), une traduction et de localisation, traducteurs peuvent vous connecter à l'outillage facile à utiliser et fournissent autant ou aussi peu d'assistance traduction comme ils le voudraient. Si vous connaissez une autre langue s'il vous plaît soutenir Cordova et contribuer. http://crowdin.net/project/cordova. Pour certaines meilleures pratiques pour utiliser l'outil Crowdin, veuillez consulter notre wiki http://wiki.apache.org/cordova/CordovaTranslations.
-
-Administrateurs de langue de Cordova, n'oubliez pas les étapes suivantes :
-
-**1. config.json**
-
-Pour chaque langue et chaque version, il y a un `config.json` qui définit le nom de la langue et comment fusionner les fichiers.
-
-**2. personnalisation de modèle HTML**
-
-Chaque langue peut remplacer le modèle par défaut dans le `template/docs/LANGUAGE`.
-
-### Règles éditoriales
-
-S'il vous plaît voir le fichier `STYLESHEET.md` pour connaître les instructions sur l'utilisation et de la langue.
-
-## Génération de Documentation avec Node.js
-
-Ce moment documentation pouvait être exécutée à l'aide de Node.js sur GNU / Linux ou sous Windows.
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### Mise en place de Node.js
-
- 1. Aller à Node.JS [téléchargements de page](http://nodejs.org/download/)
- 2. Téléchargez et installez le paquet pour votre système d'exploitation.
- 3. Commander ce référentiel à l'aide de Git
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. Installer les dépendances. Dans la racine du dossier clonés cordova-docs exécuter
-
- npm install
-
-
- 5. Maintenant vous en mesure de construire la documentation localement.
-
-### Aperçu rapide
-
-Lorsque vous effectuez des modifications mineures, il est généralement sans danger pour simplement rendre l'édité de Markdown au format HTML. De nombreux éditeurs de code ont plugins pour restituer Markdown en HTML et il ya une poignée de [bons](http://dillinger.io/) rédacteurs en ligne.
-
-Actuellement, un script de Node.JS et [joDoc-js](https://github.com/kant2002/jodoc-js) sont utilisés pour générer la documentation HTML.
-
-## Génération d'une Version Release
-
-Il y a une tâche de Rake pour incrémenter la version, générer le répertoire de version et mettre à jour la documentation de bord.
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/it/README.md
----------------------------------------------------------------------
diff --git a/doc/it/README.md b/doc/it/README.md
deleted file mode 100644
index de6515b..0000000
--- a/doc/it/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# Documentazione di Apache Cordova API
-
-La documentazione API JavaScript per [Apache Cordova](http://cordova.io/).
-
-La documentazione è disponibile presso [docs.cordova.io](http://docs.cordova.io/).
-
-## Formato della documentazione
-
-Tutta la documentazione di [Apache Cordova](http://cordova.io/) è scritto con [markdown](http://daringfireball.net/projects/markdown/syntax), un linguaggio di markup leggero che può essere impaginare in HTML. Markdown consente di documentare il nucleo di Cordova API e API specifiche della piattaforma in modo semplice e flessibile.
-
-## Struttura dei file
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## Contribuire alla documentazione
-
-### Segnalare o risolvere un problema
-
-Utilizziamo [Apache JIRA](https://issues.apache.org/jira/browse/CB)
-
-A proposito, è rock! Grazie per averci aiutato a migliorare la documentazione!
-
-### Uso di Git
-
-Sei nuovo a Git o contribuendo su GitHub?
-
-Abbiamo [scritto un paio di Git tutorial](http://wiki.apache.org/cordova/ContributorWorkflow) per aiutarvi a iniziare a contribuire alla documentazione.
-
-### L'invio di richieste di Pull
-
-Tirare le richieste sono benvenute!
-
-Apprezziamo l'uso dei rami di argomento.
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### L'aggiunta di una lingua
-
-Vuoi che la documentazione di Apache Cordova in un'altra lingua? Lo facciamo anche noi! Con il supporto della piattaforma di gestione [Crowdin](http://crowdin.net/project/cordova), traduzione e localizzazione, traduttori collegarti alla lavorazione con utensili di facile da usare e fornire tanto o poichè poca assistenza di traduzione come vorrebbero. Se si conosce un'altra lingua si prega di sostenere Cordova e contribuire. http://crowdin.net/project/cordova. Per alcune procedure consigliate per l'utilizzo lo strumento Crowdin si prega di consultare il nostro wiki http://wiki.apache.org/cordova/CordovaTranslations.
-
-Gli amministratori di lingua di Cordova, non dimenticare questi passaggi:
-
-**1. config**
-
-Per ogni lingua e versione, c'è un `config` che definisce il nome della lingua e come unire i file.
-
-**2. personalizzazione del template HTML**
-
-Ogni lingua può sovrascrivere il template predefinito nella `Lingua/docs/modello`.
-
-### Direttive editoriali
-
-Vedere il file `STYLESHEET.md` per le linee guida sull'utilizzo e la lingua.
-
-## La generazione della documentazione con node. js
-
-In questo momento la documentazione potrebbe essere eseguito utilizzando node. js su Windows o su Linux box.
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### Configurazione di node. js
-
- 1. Vai a node. js [pagina downloads](http://nodejs.org/download/)
- 2. Scaricare e installare il pacchetto per il sistema di funzionamento.
- 3. Check-out questo repository utilizzando Git
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. Installare le dipendenze. Nella radice della cartella clonata cordova-docs eseguita
-
- npm install
-
-
- 5. Ora siete in grado di generare documentazione locale.
-
-### Anteprima rapida
-
-Quando si apportano le modifiche minori, è solitamente sicuro semplicemente rendere il modificato da Markdown a HTML. Molti editor di codice sono plugin per eseguire il rendering HTML Markdown e ci sono una manciata di [buoni](http://dillinger.io/) editor online.
-
-Attualmente, un node. js script e [joDoc-js](https://github.com/kant2002/jodoc-js) vengono utilizzati per generare la documentazione HTML.
-
-## Generazione di una rilascio di versione
-
-C'è un compito di Rake per incrementare il numero di versione, la directory della versione di generare e aggiornare la documentazione di bordo.
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/ja/README.md
----------------------------------------------------------------------
diff --git a/doc/ja/README.md b/doc/ja/README.md
deleted file mode 100644
index a981da3..0000000
--- a/doc/ja/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# Apache コルドバ API ドキュメント
-
-[Apache コルドバ](http://cordova.io/)の JavaScript API ドキュメント.
-
-マニュアルは、 [docs.cordova.io](http://docs.cordova.io/).
-
-## ドキュメントの形式
-
-すべての[Apache コルドバ](http://cordova.io/)ドキュメントは[値下げ](http://daringfireball.net/projects/markdown/syntax)HTML にタイプセットすることができます軽量マークアップ言語で書き込まれます。 値下げは、コルドバのコア API やプラットフォーム固有の Api を文書化する簡単かつ柔軟な方法を提供します。
-
-## ファイル構造
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## ドキュメントに貢献
-
-### 問題を修正または報告
-
-我々 は、 [Apache JIRA](https://issues.apache.org/jira/browse/CB)を使用してください。
-
-ところで、あなたは揺れ動きます!ドキュメントの改善にご協力いただきありがとうございます!
-
-### Git を使ってください。
-
-あなたは Git または GitHub に貢献する新しいですか。
-
-我々 が[書かれていくつかの Git チュートリアル](http://wiki.apache.org/cordova/ContributorWorkflow)ドキュメントに貢献を始めるため。
-
-### プル要求を送信します。
-
-プルリクエストは大歓迎です!
-
-トピック ブランチの使用お願い申し上げます。
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### 言語を追加します。
-
-別の言語で Apache コルドバ ドキュメントですか? 我々 はあまりにも行う! [Crowdin](http://crowdin.net/project/cordova)、翻訳およびローカリゼーション管理プラットフォームのサポート、翻訳は簡単に使用できるツールにログインし、彼らのようで、少し翻訳支援を提供できます。 場合してくださいコルドバをサポートし、貢献する別の言語を知っています。 http://crowdin.net/project/cordova. Crowdin ツールを使用してのいくつかのベスト プラクティスは、私たちの wiki の http://wiki.apache.org/cordova/CordovaTranslations を参照してください。
-
-コルドバ言語管理者は、これらの手順を忘れてはいけない。
-
-**1. config.json**
-
-各言語およびバージョン、言語とファイルをマージする方法の名前を定義する`config.json`があります。
-
-**2. HTML テンプレートをカスタマイズします。**
-
-各言語の`テンプレート/ドキュメント/言語`で既定のテンプレートをオーバーライドできます。.
-
-### 編集ガイドライン
-
-言語および使用に関するガイドラインの`STYLESHEET.md`ファイルを参照してください。
-
-## Node.js のドキュメントを生成します。
-
-今、Windows または Linux ボックスのいずれか、Node.js を使用してドキュメントを実行でした。
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### Node.js を設定
-
- 1. Node.JS[のダウンロード ページ](http://nodejs.org/download/)へ
- 2. ダウンロードして、あなたの操作システムにパッケージをインストールします。
- 3. チェック アウトこのリポジトリは Git を使って
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. 依存関係をインストールします。実行クローン コルドバ docs フォルダーのルートに
-
- npm install
-
-
- 5. 今ローカルでドキュメントをビルドすることができます。
-
-### クイック プレビュー
-
-細部の編集の際、通常単に HTML に値下げから編集レンダリングしても安全です。 多くのコード エディターは、記法を HTML に表示するプラグインを持っているし、[良い](http://dillinger.io/)オンライン編集者の一握りがあります。
-
-現在、Node.JS スクリプトと[joDoc js](https://github.com/kant2002/jodoc-js)を使用して HTML ドキュメントを生成します。
-
-## バージョンのリリースを生成します。
-
-バージョンをインクリメント、バージョン、ディレクトリを生成し、エッジのマニュアルを更新する Rake タスクがあります。
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/ko/README.md
----------------------------------------------------------------------
diff --git a/doc/ko/README.md b/doc/ko/README.md
deleted file mode 100644
index a6983e1..0000000
--- a/doc/ko/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# 아파치 코르도바 API 설명서
-
-[아파치 Cordova](http://cordova.io/) 에 대 한 JavaScript API 설명서.
-
-설명서는 [docs.cordova.io](http://docs.cordova.io/) 에서 사용할 수.
-
-## 문서 형식
-
-모든 [아파치 코르도바](http://cordova.io/) 문서 [markdown](http://daringfireball.net/projects/markdown/syntax), HTML로 활자 수는 가벼운 마크업 언어와 함께 기록 됩니다. Markdown은 코르도바의 핵심 API 및 플랫폼 특정 Api를 문서화 하는 간단 하 고 유연한 방법을 제공 합니다.
-
-## 파일 구조
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## 설명서에 기여
-
-### 신고 또는 문제 해결
-
-우리는 [아파치 JIRA](https://issues.apache.org/jira/browse/CB) 사용
-
-그건 그렇고, 당신은 바위! 설명서를 개선 하는 데 도움을 주셔서 감사!
-
-### Git를 사용 하 여
-
-당신은 새로운 자식 또는 GitHub에 기여?
-
-우리는 [몇 가지 Git 튜토리얼 작성](http://wiki.apache.org/cordova/ContributorWorkflow) 설명서에 기여와 함께 시작할 수 있도록.
-
-### 끌어오기 요청을 보내는
-
-끌어오기 요청은 환영 합니다!
-
-항목 지점의 사용 부탁 드립니다.
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### 언어 추가
-
-다른 언어에서 아파치 코르도바 설명서 보기 우리는 너무 해! [Crowdin](http://crowdin.net/project/cordova), 번역 및 로컬라이제이션 관리 플랫폼의 지원, 번역 수 사용 하기 쉬운 툴에 로그인 하 고 그들이 했던 것 처럼 작은 번역 지원을 제공. 당신이 알고 있다면 다른 언어 코르도바를 지원 하 고 기여 하십시오. http://crowdin.net/project/cordova. Crowdin 도구를 사용 하 여에 대 한 몇 가지 모범 사례에 대 한 우리의 위 키 http://wiki.apache.org/cordova/CordovaTranslations를 참조 하십시오.
-
-코르도바 언어 관리자는 다음이 단계를 잊지 마세요:
-
-**1입니다. config.json**
-
-각 언어 및 버전에 대 한 파일을 병합 하는 방법과 언어의 이름을 정의 하는 `config.json` 입니다.
-
-**2. 사용자 지정 HTML 서식 파일**
-
-각 언어 `서식 파일/문서/언어` 에서 기본 서식 파일을 재정의할 수 있습니다..
-
-### 광고문 안 가이드
-
-언어 및 사용에 대 한 `STYLESHEET.md` 파일을 참조 하십시오.
-
-## Node.js 함께 문서 생성
-
-지금 문서 Windows, 또는 리눅스 상자에 Node.js를 사용 하 여 실행할 수 있습니다.
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### Node.js를 설정
-
- 1. Node.JS [다운로드 페이지](http://nodejs.org/download/) 이동
- 2. 다운로드 및 운영 체제에 대 한 패키지를 설치 합니다.
- 3. 체크 아웃 Git를 사용 하 여이 저장소
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. 종속성을 설치 합니다. 실행 복제 코르도바-오피스 폴더의 루트에
-
- npm install
-
-
- 5. 지금 당신은 로컬로 문서를 만들 수입니다.
-
-### 빠른 미리 보기
-
-사소한 편집 때, 그것은 일반적으로 간단 하 게 렌더링 하는 편집 Markdown에서 HTML로 안전입니다. 많은 코드 에디터는 Markdown HTML로 렌더링 하는 플러그인 그리고 [좋은](http://dillinger.io/) 온라인 편집자의 한 줌 있다.
-
-현재, Node.JS 스크립트와 [joDoc js](https://github.com/kant2002/jodoc-js) HTML 문서를 생성 하 데 사용 됩니다.
-
-## 생성 버전 출시
-
-버전 디렉터리를 생성 하 버전 증가 가장자리 설명서를 업데이트 레이크 작업이입니다.
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/pl/README.md
----------------------------------------------------------------------
diff --git a/doc/pl/README.md b/doc/pl/README.md
deleted file mode 100644
index d4feb82..0000000
--- a/doc/pl/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# Apache Cordova API Documentation
-
-Dokumentacja JavaScript API dla [Apache Cordova](http://cordova.io/).
-
-Dokumentacja jest dostępna na [docs.cordova.io](http://docs.cordova.io/).
-
-## Format dokumentacji
-
-Całą dokumentację, [Apache Cordova](http://cordova.io/) jest napisany z [promocji cenowych](http://daringfireball.net/projects/markdown/syntax), język znaczników, które mogą być składane do HTML. Markdown zapewnia prosty i elastyczny sposób do dokumentu rdzeń Cordova w API i API platformy.
-
-## Struktura pliku
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## Przyczyniając się do dokumentacji
-
-### Raport lub rozwiązać problem
-
-Używamy [Apache JIRA](https://issues.apache.org/jira/browse/CB)
-
-Mimochodem ty skała! Dzięki za pomoc nam poprawić dokumentację!
-
-### Za pomocą Git
-
-Czy jesteś nowym Git lub przyczyniających się na GitHub?
-
-Mamy [napisane kilka tutoriali Git](http://wiki.apache.org/cordova/ContributorWorkflow) , które pomogą Ci rozpocząć pracę z przyczyniając się do dokumentacji.
-
-### Wysyłanie żądań Pull
-
-Wyciągnąć wnioski są mile widziane!
-
-Dziękujemy za korzystanie z gałęzi tematycznych.
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### Dodanie języka
-
-Czy chcesz, aby Apache Cordova dokumentacji w innym języku? Robimy też! Przy wsparciu [Crowdin](http://crowdin.net/project/cordova), tłumaczenie i lokalizacja platformy zarządzania tłumaczy można zalogować się łatwy wobec używać narzędzi i zapewnić jak dużo lub za mało tłumaczenie pomocy, jak chcą. Jeśli znasz inny język, prosimy o wsparcie Cordova i przyczynić się. http://crowdin.net/project/cordova. Niektóre najważniejsze wskazówki dotyczące korzystania z narzędzia Crowdin Zobacz nasze wiki http://wiki.apache.org/cordova/CordovaTranslations.
-
-Cordova język Administratorzy, nie zapomnij następujące kroki:
-
-**1. config.json**
-
-Dla każdego języka i wersji jest `config.json` , która określa nazwę języka oraz jak scalić pliki.
-
-**2. dostosowywanie szablonu HTML**
-
-Każdy język można zastąpić domyślny szablon w `Język szablonu/dokumenty`.
-
-### Wskazówkami redakcyjnymi
-
-Zobacz plik `STYLESHEET.md` do wytycznych na język i sposób użycia.
-
-## Generowanie dokumentacji z Node.js
-
-Już teraz dokumentacji mogą być uruchamiane za pomocą Node.js na Windows, albo na linux'ie.
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### Definiowanie Node.js
-
- 1. Przejdź do Node.JS, [pliki do pobrania strony](http://nodejs.org/download/)
- 2. Pobierz i zainstaluj pakiet dla systemu pracy.
- 3. Zamówienie to repozytorium za pomocą Git
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. Zainstalować zależności. W głównym folderze sklonowany cordova dokumenty uruchomić
-
- npm install
-
-
- 5. Teraz jesteś w stanie budować dokumentacji lokalnie.
-
-### Szybki podgląd
-
-Podczas dokonywania drobnych zmian, to zazwyczaj po prostu uczynić edytowane z Markdown do HTML. Wiele edytorów kodu masz pluginy do renderowania Markdown do HTML i istnieje kilka [dobrych](http://dillinger.io/) redaktorów online.
-
-Obecnie skrypt Node.JS i [joDoc-js](https://github.com/kant2002/jodoc-js) są używane do generowania dokumentacji HTML.
-
-## Generowanie wersji
-
-Jest zadaniem Rake przyrost wersji, wersji katalogu, i aktualizacji dokumentacji krawędzi.
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/doc/zh/README.md
----------------------------------------------------------------------
diff --git a/doc/zh/README.md b/doc/zh/README.md
deleted file mode 100644
index 9ca112a..0000000
--- a/doc/zh/README.md
+++ /dev/null
@@ -1,107 +0,0 @@
-# Apache 科爾多瓦 API 文檔
-
-[Apache 科爾多瓦](http://cordova.io/)JavaScript API 文檔.
-
-該文檔是發售[docs.cordova.io](http://docs.cordova.io/).
-
-## 文檔格式
-
-所有[Apache 科爾多瓦](http://cordova.io/)文檔編寫時[降價](http://daringfireball.net/projects/markdown/syntax)，可以到 HTML 排版的羽量級標記語言。 降價提供了一種簡單而靈活的方式來記錄科爾多瓦的核心 API 和特定于平臺的 Api。
-
-## 檔結構
-
- docs/
- docs/LANGUAGE
- docs/LANGUAGE/VERSION
- docs/LANGUAGE/VERSION/cordova/
- docs/LANGUAGE/VERSION/guide/platforms/PLATFORMNAME/
-
-
-## 檔作出貢獻
-
-### 報告或解決問題
-
-我們使用[Apache JIRA](https://issues.apache.org/jira/browse/CB)
-
-順便說一句，你搖滾!感謝您説明我們改進文檔!
-
-### 使用 Git
-
-你是新到 Git 或在 GitHub 上作出貢獻?
-
-我們要[寫幾個 Git 教程](http://wiki.apache.org/cordova/ContributorWorkflow)説明您開始使用檔作出貢獻。
-
-### 發送的請求
-
-請求，歡迎!
-
-我們欣賞主題設立分支機搆。
-
- git checkout -b issue_23
-
- # code
-
- git commit -m "Issue 23: Fix a bad bug."
-
- git push origin issue_23
-
- # send pull request from branch issue_23 to cordova:master
-
-
-### 添加一種語言
-
-你想要另一種語言中的 Apache 科爾多瓦文檔嗎? 我們也做了! [Crowdin](http://crowdin.net/project/cordova)、 翻譯和當地語系化管理平臺的支援下，譯者可以登錄到使用方便模具並提供作為多或少的翻譯協助，會像他們。 如果你知道請支援科爾多瓦和作出貢獻的另一種語言。 http://crowdin.net/project/cordova. 使用 Crowdin 工具的一些最佳做法，請參閱我們的 wiki HTTP://wiki.apache.org/cordova/CordovaTranslations。
-
-科爾多瓦語言管理員，別忘了這些步驟:
-
-**1.config.json**
-
-對於每種語言和版本，還有`config.json`所定義的語言以及如何合併的檔的名稱。
-
-**2.自訂 HTML 範本**
-
-每一種語言可以重寫預設範本在`templates/docs/LANGUAGE`.
-
-### 編輯指南
-
-請參閱準則`STYLESHEET.md`檔的語言和使用方式。
-
-## 生成文檔與 Node.js
-
-現在，文檔可以使用 Node.js，Windows，或 Linux 機器上運行。
-
- $ rm -r tmp public # Clear out old docs
- $ ./bin/genjs # compile all docs
- $ ./bin/genjs en edge # compile English Edge docs
- $ ./bin/genjs ru edge # compile Russian Edge docs
- $ ./bin/genjs es 3.5.0 # compile Spanish 3.5.0 docs
-
-
-### 設置 Node.js
-
- 1. 去 Node.JS[下載頁](http://nodejs.org/download/)
- 2. 下載並安裝包為您的作業系統。
- 3. 簽出此存儲庫使用 Git
-
- git clone https://github.com/apache/cordova-docs
-
-
- 4. 安裝的依賴關係。在運行的克隆的科爾多瓦 docs 資料夾的根目錄
-
- npm install
-
-
- 5. 現在，您能夠構建本地文檔。
-
-### 快速預覽
-
-小編輯時，它通常是安全，使 HTML 簡單地編輯從降價。 很多代碼編輯器外掛程式要呈現為 HTML 的降價和有極少數的[好](http://dillinger.io/)線上編輯。
-
-目前，Node.JS 腳本和[joDoc js](https://github.com/kant2002/jodoc-js)用於生成的 HTML 文檔。
-
-## 生成版本
-
-還有 Rake 任務，將版本遞增，生成版本目錄中，並更新邊緣文檔。
-
- # generate version 4.1.0 for english.
- .\bin\incrementversion en 4.1.0
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/jodoc.js
----------------------------------------------------------------------
diff --git a/lib/cordova/jodoc.js b/lib/cordova/jodoc.js
deleted file mode 100644
index 3ee184d..0000000
--- a/lib/cordova/jodoc.js
+++ /dev/null
@@ -1,130 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-/*global which, exec */
-var fs = require("fs-extra");
-var path = require("path");
-require('shelljs/global');
-
-var JoDoc = (function () {
- 'use strict';
-
- var JO_DOC_CLI = "jodoc",
- TEMPLATE_PATH = path.resolve(path.join(path.dirname(module.filename), '..', '..', 'template', 'docs')),
- useLocalJoDoc = true;
-
- /**
- * Creates a new instance of JoDoc
- * @param inputDirectory Directory which contains files which has to be processed.
- * @param outputDirectory Directory to which store generated files.
- * @param options Options for the generation process.
- */
- function JoDoc(inputDirectory, outputDirectory, options) {
- this.input_directory = inputDirectory;
- this.output_directory = outputDirectory;
- this.options = options;
-
- this.template_directories = [ path.join(TEMPLATE_PATH, "default") ];
- if (options.lang) {
- this.template_directories.push(path.join(TEMPLATE_PATH, options.lang));
- }
-
- this.check_dependencies();
- }
-
- JoDoc.prototype.check_dependencies = function () {
- if (!which('jodoc') && !useLocalJoDoc) {
- console.error('The jodoc script is not in your path');
- process.exit(1);
- }
-
- [this.input_directory, this.template_directories[0]].forEach(function (dir) {
- if (!fs.existsSync(dir)) {
- console.error("The directory " + dir + " has to be present");
- process.exit(1);
- }
-
- var stat = fs.lstatSync(dir);
- if (!stat.isDirectory()) {
- console.error("The path " + dir + " is not directory.");
- process.exit(1);
- }
- });
- };
-
- JoDoc.prototype.run = function () {
- var self = this,
- currentDirectory = process.cwd(),
- nullDevice = "/dev/null",
- templateFile = path.join(this.output_directory, "index.html"),
- commandLine,
- child,
- executableName;
- // Copy HTML template assets
- this.template_directories.forEach(function (templateDir) {
- if (!fs.existsSync(templateDir)) {
- if (self.options.verbose > 0) {
- console.log("Template folder " + templateDir + " not exists, skipping");
- }
-
- return;
- }
-
- var stat = fs.lstatSync(templateDir);
- if (!stat.isDirectory()) {
- return;
- }
-
- fs.copySync(templateDir, self.output_directory);
- });
-
- process.chdir(this.input_directory);
-
- executableName = JO_DOC_CLI;
- if (useLocalJoDoc) {
- executableName = path.join(module.filename, "../../../node_modules/.bin/jodoc");
- }
-
- commandLine = executableName + " --output \"" + this.output_directory + "\" --title \"Cordova API Documentation\" --template \"" + templateFile + "\" ./";
- if (self.options.verbose > 0) {
- console.log("Running joDoc-js with command line:");
- console.log(commandLine);
- }
-
- if (this.options.verbose < 2) {
- commandLine = commandLine + " > " + nullDevice + " 2> " + nullDevice;
- }
-
- if (this.options.verbose > 1) {
- console.info("Running jodoc from " + this.input_directory + " directory");
- console.info(commandLine);
- }
-
- child = exec(commandLine);
- if (child.code !== 0) {
- console.error("Error during execution of jodoc. Error code is: " + child.code);
- process.exit(child.code);
- }
-
- process.chdir(currentDirectory);
- };
-
- return JoDoc;
-}());
-module.exports = JoDoc;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/addtitle.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/addtitle.js b/lib/cordova/post/addtitle.js
deleted file mode 100644
index 5920f92..0000000
--- a/lib/cordova/post/addtitle.js
+++ /dev/null
@@ -1,72 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var path = require("path");
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var AddTitle = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function AddTitle(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Adding title";
- }
-
- AddTitle.prototype.run = function (file, $) {
- if (path.extname(file) !== ".html") {
- return;
- }
-
- if (this.options.verbose > 1) {
- console.log("Add title to file " + file);
- }
-
- var title_source,
- title_target,
- title;
- title_source = $('#content > h1');
- if (title_source.length === 0) {
- return null;
- }
-
- title_source = $(title_source[0]);
- title_target = $('#subheader > h1');
- if (title_target.length === 0) {
- return null;
- }
-
- title_target = $(title_target[0]);
- if (this.options.verbose > 1) {
- console.log("Change title from " + title_target.text() + " to " + title_source.text());
- }
-
- title = title_source.text();
- title_target.text(title);
- return title;
- };
-
- return AddTitle;
-}());
-module.exports = AddTitle;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/index.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/index.js b/lib/cordova/post/index.js
deleted file mode 100644
index 4200635..0000000
--- a/lib/cordova/post/index.js
+++ /dev/null
@@ -1,29 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var AddTitle = require("./addtitle"),
- UpdateIndex = require("./updateindex"),
- UpdateKeywordIndex = require("./updatekeywordindex"),
- TableOfContents = require("./tableofcontents"),
- VersionMenu = require("./versionmenu"),
- NavigationMenu = require("./navigationmenu"),
- Prettify = require("./prettify"),
- NoIndex = require("./noindex"),
- StepProcessor = require("./stepprocessor");
-module.exports = [StepProcessor, /*AddTitle,*/ UpdateIndex, UpdateKeywordIndex/*, TableOfContents, VersionMenu, NavigationMenu, Prettify, NoIndex*/];
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/navigationmenu.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/navigationmenu.js b/lib/cordova/post/navigationmenu.js
deleted file mode 100644
index 869d223..0000000
--- a/lib/cordova/post/navigationmenu.js
+++ /dev/null
@@ -1,120 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio'),
- FileHelpers = require("../../file_helpers");
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var NavigationMenu = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function NavigationMenu(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Building navigation menu";
- this.sections = [];
-
- var filename = path.join(FileHelpers.getTmpDirectory(), 'jodoc', 'index.md.html'),
- $,
- h1_set,
- ul_set,
- count,
- i,
- links,
- appendLink;
- if (!fs.existsSync(filename)) {
- throw new Error("index.md.html was not generated in " + FileHelpers.getTmpDirectory() + "/jodoc");
- }
- $ = cheerio.load(fs.readFileSync(filename));
- h1_set = $('#home > h1');
- ul_set = $('#home > ul');
- count = h1_set.length;
-
- function getAppender(links) {
- function appendLink(index, element) {
- links.push(element);
- }
-
- return appendLink;
- }
-
- for (i = 0; i < count; i += 1) {
- links = [];
- appendLink = getAppender(links);
-
- $('li > h2 > a', ul_set[i]).each(appendLink);
-
- this.sections.push({
- 'title': $(h1_set[i]).text(),
- 'links': links
- });
- }
- }
-
- NavigationMenu.prototype.run = function (file, $) {
- var i,
- section;
- if (path.extname(file) !== ".html") {
- return;
- }
-
- if (this.options.verbose > 1) {
- console.log("Appending file to nav menu " + file);
- }
-
- for (i = 0; i < this.sections.length; i += 1) {
- section = this.sections[i];
- this.insertTitle(section.title, $);
- this.insertLinks(section.links, $);
- }
- };
-
- NavigationMenu.prototype.insertTitle = function (title, $) {
- var element = cheerio("<h1></h1>");
- element.text(title);
- $('#sidebar').first().append(element).append("\n");
- };
-
- NavigationMenu.prototype.insertLinks = function (links, $) {
- var ul = cheerio("<ul></ul>"),
- li,
- i,
- link;
-
- ul.append("\n");
- for (i = 0; i < links.length; i += 1) {
- link = links[i];
- li = cheerio("<li></li>");
- li.append(link);
- ul.append(li).append("\n");
- }
-
- $('#sidebar').first().append(ul).append("\n");
- };
-
- return NavigationMenu;
-}());
-module.exports = NavigationMenu;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/noindex.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/noindex.js b/lib/cordova/post/noindex.js
deleted file mode 100644
index 0dae885..0000000
--- a/lib/cordova/post/noindex.js
+++ /dev/null
@@ -1,106 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio'),
- FileHelpers = require("../../file_helpers");
-
-/**
-* Preprocessor which adds meta tag robot=noindex, to all not latest versions of the docs.
-*/
-var NoIndex = (function () {
- 'use strict';
- var latestVersion = null;
-
- function getLatestIndex() {
- // skip if we have the latest version
- if (latestVersion !== null) {
- return latestVersion;
- }
-
- // collect all english versions because they are the most up-to-date
- var docs_path = FileHelpers.getDefaultInputDirectory(),
- versions = [],
- lang_dir = path.join(docs_path, 'en'),
- version_dirs,
- last;
-
- version_dirs = fs.readdirSync(lang_dir);
- version_dirs.forEach(function (version) {
- var configFile = path.join(lang_dir, version, "config.json"),
- configData = JSON.parse(fs.readFileSync(configFile));
- versions.push(version);
- });
-
- // sort the version list because Dir does not guarantee an order
- versions.sort().reverse();
-
- // we want the latest stable release
- // if edge is the most recent, remove it
- last = versions.shift();
- if (last === 'edge') {
- last = versions.shift();
- }
-
- // return the latest version
- latestVersion = last;
- return last;
- }
-
- function createNoIndexMeta() {
- var element = cheerio("<meta></meta>");
- element.attr('name', 'robots');
- element.attr('label', 'noindex');
- return element;
- }
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function NoIndex(options) {
- latestVersion = getLatestIndex();
- this.options = options || { verbose: 0 };
- this.stage = "Insert noindex";
- }
-
- NoIndex.prototype.run = function (file, $) {
- if (!file.match(/\.html$/)) {
- return null;
- }
-
- var version = this.options.version,
- language = this.options.lang,
- meta_tags;
- if (latestVersion === version && language === 'en') {
- if (this.options.verbose > 1) {
- console.log("File belongs to language " + language + " and version " + version + " which is assumed to be latest");
- }
-
- return;
- }
-
- meta_tags = $('head meta');
- meta_tags.append(createNoIndexMeta());
- };
-
- return NoIndex;
-}());
-module.exports = NoIndex;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/prettify.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/prettify.js b/lib/cordova/post/prettify.js
deleted file mode 100644
index 66975a7..0000000
--- a/lib/cordova/post/prettify.js
+++ /dev/null
@@ -1,54 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var path = require("path");
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var Prettify = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function Prettify(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Prettify";
- }
-
- Prettify.prototype.run = function (file, $) {
- if (path.extname(file) !== ".html") {
- return;
- }
-
- if (this.options.verbose > 1) {
- console.log("Prettify file " + file);
- }
-
- var element;
- element = $('#content pre');
- element.attr('class', 'prettyprint');
- return element;
- };
-
- return Prettify;
-}());
-module.exports = Prettify;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/stepprocessor.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/stepprocessor.js b/lib/cordova/post/stepprocessor.js
deleted file mode 100644
index 14dd28a..0000000
--- a/lib/cordova/post/stepprocessor.js
+++ /dev/null
@@ -1,105 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio');
-var AddTitle = require("./addtitle"),
- TableOfContents = require("./tableofcontents"),
- VersionMenu = require("./versionmenu"),
- NavigationMenu = require("./navigationmenu"),
- Prettify = require("./prettify"),
- NoIndex = require("./noindex");
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var StepProcessor = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of StepProcessor
- * @param options Options for the generation process.
- */
- function StepProcessor(options) {
- var self = this;
- this.options = options || { verbose: 0, timing: -1 };
- this.stage = "Step 1";
- this.processors = [AddTitle, TableOfContents, VersionMenu, NavigationMenu, Prettify, NoIndex].map(function (StepConstructor) {
- var stepObject;
- self.captureExecutionTime(" Substep init " + StepConstructor, 2, function () {
- stepObject = new StepConstructor(self.options);
- });
- return stepObject;
- });
- }
-
- StepProcessor.prototype.run = function (file) {
- var self = this,
- $,
- steps;
- if (path.extname(file) !== ".html") {
- return;
- }
-
- $ = cheerio.load(fs.readFileSync(file));
- this.processors.forEach(function (stepObject) {
- self.captureExecutionTime(" Substep run: " + stepObject.stage, 2, function () {
- stepObject.run(file, $);
- });
- });
- // Save all content to file
- fs.writeFileSync(file, $.html());
- };
-
- StepProcessor.prototype.captureExecutionTime = function (step_name, level, callback) {
- var startDate,
- finishDate,
- timingLevel = -1,
- secondsPassed;
- if (this.options.timing) {
- if (this.options.timing === true) {
- timingLevel = 0;
- } else {
- timingLevel = this.options.timing;
- }
- }
-
- if (timingLevel >= level) {
- startDate = new Date();
- if (this.options.verbose > 0) {
- console.log(startDate, "Start " + step_name);
- }
- }
-
- callback.apply(this);
- if (timingLevel >= level) {
- finishDate = new Date();
- if (this.options.verbose > 0) {
- console.log(finishDate, "Finish " + step_name);
- }
-
- secondsPassed = (finishDate.valueOf() - startDate.valueOf()) / 1000;
- console.log(step_name + ". Total time: ", secondsPassed);
- }
- };
-
- return StepProcessor;
-}());
-module.exports = StepProcessor;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/tableofcontents.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/tableofcontents.js b/lib/cordova/post/tableofcontents.js
deleted file mode 100644
index 565e42b..0000000
--- a/lib/cordova/post/tableofcontents.js
+++ /dev/null
@@ -1,116 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio');
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var TableOfContents = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of TableOfContents
- * @param options Options for the generation process.
- */
- function TableOfContents(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Building TOC";
- }
-
- TableOfContents.prototype.run = function (file, doc) {
- var filenamePart = path.basename(file),
- option_set = [],
- current_h1 = "",
- indentation = "\xa0\xa0\xa0\xa0\xa0\xa0",
- select,
- subheader;
- if (filenamePart === "_index.html" || filenamePart === "index.html" || filenamePart === "index.md.html") {
- return;
- }
-
- if (path.extname(file) !== ".html") {
- return;
- }
-
- doc("#content h1, #content h2").each(function (index, elementDom) {
- var element = cheerio(elementDom),
- child = element.children().first(),
- option,
- s,
- anchorName,
- anchor;
- if (elementDom.name === 'h1') {
- current_h1 = element.text();
- option = cheerio("<option></option");
- anchorName = child.attr('name');
- if (anchorName !== null && anchorName !== undefined) {
- anchorName = encodeURIComponent(anchorName);
- option.attr('value', anchorName.replace(/\s/g, '%20'));
- }
-
- option.text(element.text());
- option_set.push(option);
- } else {
- // Remove all leading and trailing non-word characters
- // Replace all inner non-word characters with an underscore
- // Replace all spaces since encodeURIComponent not produce correct URI
- s = element.text()
- .replace(/^\W+|\W+$/g, '')
- .replace(/\W+/g, '_').toLowerCase();
- option = cheerio("<option></option>");
- anchorName = current_h1 + "_" + s;
- anchorName = encodeURIComponent(anchorName);
- anchorName = anchorName.replace(/%2520/g, '%20');
- option.attr('value', anchorName);
- option.text(indentation + "- " + element.text());
- option_set.push(option);
-
- anchor = cheerio("<a></a>");
- anchor.attr('name', anchorName);
- anchor.text(element.text());
- element.text('');
- element.append(anchor);
- }
- });
-
- // Return if one or less elements found (useless selection box)
- if (option_set.length <= 1) {
- return null;
- }
-
- // Add select menu to the subheader
- select = cheerio("<select></select>");
- option_set.forEach(function (optionGroup) {
- select.append(optionGroup);
- });
- subheader = doc("#subheader > small").first();
- if (subheader.length === 0) {
- return null;
- }
-
- subheader.append(select);
- return option_set;
- };
-
- return TableOfContents;
-}());
-module.exports = TableOfContents;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/updateindex.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/updateindex.js b/lib/cordova/post/updateindex.js
deleted file mode 100644
index a8f3a79..0000000
--- a/lib/cordova/post/updateindex.js
+++ /dev/null
@@ -1,65 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio');
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var UpdateIndex = (function () {
- 'use strict';
- var header_title = 'Home';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function UpdateIndex(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Update index";
- this.header_title = header_title;
- }
-
- UpdateIndex.prototype.run = function (file) {
- if (path.basename(file) !== "index.md.html") {
- return false;
- }
-
- if (this.options.verbose > 1) {
- console.info("Update index");
- }
-
- var $ = cheerio.load(fs.readFileSync(file)),
- title_target;
- title_target = $('#subheader > h1');
- if (title_target.length !== 0) {
- title_target = $(title_target[0]);
- title_target.text(header_title);
- }
-
- fs.writeFileSync(file, $.html());
- fs.renameSync(file, path.join(path.dirname(file), "index.html"));
- return true;
- };
-
- return UpdateIndex;
-}());
-module.exports = UpdateIndex;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/updatekeywordindex.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/updatekeywordindex.js b/lib/cordova/post/updatekeywordindex.js
deleted file mode 100644
index e5a48f9..0000000
--- a/lib/cordova/post/updatekeywordindex.js
+++ /dev/null
@@ -1,80 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio');
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var UpdateKeywordIndex = (function () {
- 'use strict';
- var header_title = 'Keyword Index',
- content_title = 'Keyword Index';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function UpdateKeywordIndex(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Update keywork index";
- this.header_title = header_title;
- this.content_title = content_title;
- }
-
- UpdateKeywordIndex.prototype.run = function (file) {
- if (path.basename(file) !== "_index.html") {
- return false;
- }
-
- if (this.options.verbose > 1) {
- console.info("Update keyword index");
- }
-
- var $ = cheerio.load(fs.readFileSync(file)),
- element,
- content;
- element = $('#subheader > h1');
- if (element.length !== 0) {
- element = $(element[0]);
- element.text(header_title);
- }
-
- element = $('#content > h1');
- if (element.length !== 0) {
- element = $(element[0]);
- element.text(content_title);
- }
-
- element = $('#content > hr');
- if (element.length !== 0) {
- element = $(element[0]);
- element.remove();
- }
-
- content = $.html();
- content = content.replace(/"index\.md\.html/g, '"index.html');
- fs.writeFileSync(file, content);
- };
-
- return UpdateKeywordIndex;
-}());
-module.exports = UpdateKeywordIndex;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/post/versionmenu.js
----------------------------------------------------------------------
diff --git a/lib/cordova/post/versionmenu.js b/lib/cordova/post/versionmenu.js
deleted file mode 100644
index 84bda9b..0000000
--- a/lib/cordova/post/versionmenu.js
+++ /dev/null
@@ -1,143 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var cheerio = require('cheerio');
-
-/**
-* Preprocessor which updates top stripe with header or the page.
-*/
-var VersionMenu = (function () {
- 'use strict';
- var languages = null,
- versions = null;
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function VersionMenu(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Populate version menu";
- if (languages === null) {
- languages = [];
- versions = [];
- this.buildVersionsData();
- }
-
- this.generatedMenu = this.generateMenu();
- }
-
- VersionMenu.prototype.run = function (file, $) {
- if (path.extname(file) !== ".html") {
- return;
- }
-
- if (this.options.verbose > 1) {
- console.info("Building version menu for file " + file);
- }
-
- var element;
-
- element = $('#header small select').first();
- this.generatedMenu.forEach(function (optionGroup) {
- element.append(optionGroup).append("\n");
- });
- };
-
- VersionMenu.prototype.buildVersionsData = function () {
- var docs_path = path.resolve(path.join(module.filename, '..', '..', '..', '..', 'docs')),
- lang_dirs,
- lang_labels = [];
-
- lang_dirs = fs.readdirSync(docs_path);
- lang_dirs.forEach(function (lang) {
- versions[lang] = [];
- var lang_dir = path.join(docs_path, lang),
- version_dirs;
- version_dirs = fs.readdirSync(lang_dir);
- version_dirs.forEach(function (version) {
- var configFile = path.join(lang_dir, version, "config.json"),
- configData = JSON.parse(fs.readFileSync(configFile));
- versions[lang].push(version);
- lang_labels[lang] = configData.language;
- });
-
- languages.push({ lang: lang, label: lang_labels[lang] });
- });
- languages = languages.sort(function (a, b) {
- if (a.label === b.label) {
- return 0;
- }
-
- if (a.label > b.label) {
- return 1;
- }
-
- return -1;
- });
- };
-
- VersionMenu.prototype.generateMenu = function () {
- var result = [],
- langGroup,
- versionData,
- versionOption,
- lang,
- versionIndex,
- version,
- mapper,
- key;
-
- mapper = function (item) {
- return item;
- };
-
- for (key in languages) {
- if (languages.hasOwnProperty(key)) {
- lang = languages[key].lang;
- langGroup = cheerio("<optgroup></optgroup>");
- langGroup.append("\n");
- langGroup.attr('label', languages[key].label);
- langGroup.attr('value', lang);
-
- versionData = versions[lang].map(mapper).reverse();
- for (versionIndex = 0; versionIndex < versionData.length; versionIndex = versionIndex + 1) {
- version = versionData[versionIndex];
- versionOption = cheerio("<option></option>");
- if (this.options.version === version && this.options.lang === lang) {
- versionOption.attr('selected', 'selected');
- }
-
- versionOption.attr('value', version);
- versionOption.text(version);
- langGroup.append(versionOption).append("\n");
- }
-
- result.push(langGroup);
- }
- }
-
- return result;
- };
-
- return VersionMenu;
-}());
-module.exports = VersionMenu;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/pre/filemerger.js
----------------------------------------------------------------------
diff --git a/lib/cordova/pre/filemerger.js b/lib/cordova/pre/filemerger.js
deleted file mode 100644
index e55da60..0000000
--- a/lib/cordova/pre/filemerger.js
+++ /dev/null
@@ -1,109 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra"),
- path = require("path"),
- FileHelpers = require("../../file_helpers");
-
-var FileMerger = (function () {
- 'use strict';
-
- var config = null;
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function FileMerger(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Merge files";
-
- config = null;
- }
-
- FileMerger.prototype.run = function (file) {
- if (this.options.verbose > 1) {
- console.log("Merge file " + file);
- }
-
- if (file.match(/\/guide\//)) {
- return null;
- }
-
- if (!fs.existsSync(file)) {
- return null;
- }
-
- this.filename = path.basename(file);
- this.directory = path.dirname(file);
-
- var filesToAppend,
- cfg = this.config(),
- i,
- filepath;
- if (!cfg.hasOwnProperty(this.filename)) {
- return null;
- }
-
- filesToAppend = cfg[this.filename];
- for (i = 0; i < filesToAppend.length; i += 1) {
- filepath = filesToAppend[i];
-
- // skip the file that we're merging into because it's listed in config.json
- if (path.basename(filepath) === this.filename) {
- if (this.options.verbose > 0) {
- console.log("Skipping " + filesToAppend[i] + " from " + this.filename + " section since it has same base name as file to merge");
- }
- } else {
- filepath = path.join(FileHelpers.getTmpDirectory(), 'docs', filepath);
- fs.appendFileSync(file, "\n\n---\n");
- if (!fs.existsSync(filepath)) {
- console.log("File " + filepath + " is missing and thus don't merged with " + file);
- } else {
- fs.appendFileSync(file, fs.readFileSync(filepath, "utf-8").trim());
- fs.removeSync(filepath);
- }
- }
- }
- };
-
- FileMerger.prototype.config = function () {
- if (config !== null) {
- return config;
- }
-
- var directory = this.directory,
- file,
- configJSON;
- while (config === null) {
- file = path.join(directory, 'config.json');
- if (fs.existsSync(file)) {
- configJSON = fs.readFileSync(file);
- config = JSON.parse(configJSON).merge;
- } else {
- directory = fs.dirname(directory);
- }
- }
-
- return config;
- };
-
- return FileMerger;
-}());
-module.exports = FileMerger;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/pre/index.js
----------------------------------------------------------------------
diff --git a/lib/cordova/pre/index.js b/lib/cordova/pre/index.js
deleted file mode 100644
index db3de0b..0000000
--- a/lib/cordova/pre/index.js
+++ /dev/null
@@ -1,22 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var FileMerger = require("./filemerger"),
- YamlFrontMatter = require("./yamlfrontmatter");
-module.exports = [YamlFrontMatter, FileMerger];
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/cordova/pre/yamlfrontmatter.js
----------------------------------------------------------------------
diff --git a/lib/cordova/pre/yamlfrontmatter.js b/lib/cordova/pre/yamlfrontmatter.js
deleted file mode 100644
index fc8ef4e..0000000
--- a/lib/cordova/pre/yamlfrontmatter.js
+++ /dev/null
@@ -1,67 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra"),
- path = require("path"),
- yaml = require("js-yaml");
-
-var YamlFrontMatter = (function () {
- 'use strict';
-
- /**
- * Creates a new instance of FileMerger
- * @param options Options for the generation process.
- */
- function YamlFrontMatter(options) {
- this.options = options || { verbose: 0 };
- this.stage = "Starting YAML stripping";
- }
-
- YamlFrontMatter.prototype.run = function (file) {
- if (this.options.verbose > 1) {
- console.log("String YAML from file " + file);
- }
-
- var content = fs.readFileSync(file, "utf8"),
- yamlRegexStripper = /^(---\s*\n[\s\S]*?\n?)^(---\s*$\n?)/m,
- match = yamlRegexStripper.exec(content),
- yamlData;
- if (match === null) {
- return {};
- }
-
- try {
- yamlData = yaml.safeLoad(match[1]);
- } catch (yamle) {
- console.error("File: " + file);
- if (this.options.verbose > 1) {
- console.error("YAML Exception during processing following content:\n" + content);
- }
-
- throw yamle;
- }
-
- content = content.substr(match[0].length);
- fs.writeFileSync(file, content);
- return yamlData;
- };
-
- return YamlFrontMatter;
-}());
-module.exports = YamlFrontMatter;
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/5f554950/lib/docs_comparer.js
----------------------------------------------------------------------
diff --git a/lib/docs_comparer.js b/lib/docs_comparer.js
deleted file mode 100644
index 9548e16..0000000
--- a/lib/docs_comparer.js
+++ /dev/null
@@ -1,251 +0,0 @@
-/*
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-*/
-/*jslint node: true */
-var fs = require("fs-extra");
-var path = require("path");
-var JoDoc = require("./cordova/jodoc");
-var FileHelpers = require("./file_helpers");
-var cheerio = require('cheerio');
-var jsdiff = require('diff');
-require('colors');
-
-var DocsComparer = (function () {
- 'use strict';
-
- function processEachFile(source_path, fileCallback, directoryCallback) {
- var directoryEntries = fs.readdirSync(source_path);
- directoryEntries.forEach(function (dirEntry) {
- var fullPath = path.join(source_path, dirEntry),
- stat;
- if (!fs.existsSync(fullPath)) {
- return;
- }
-
- stat = fs.lstatSync(fullPath);
- if (stat.isFile()) {
- fileCallback(fullPath);
- return;
- }
-
- if (stat.isDirectory()) {
- if (directoryCallback(fullPath)) {
- processEachFile(fullPath, fileCallback, directoryCallback);
- }
-
- return;
- }
- });
- }
-
- /**
- * Creates a new instance of DocsComparer
- * @param inputDirectory Directory which contains files which has to be processed.
- * @param outputDirectory Directory to which store generated files.
- */
- function DocsComparer(originalDirectory, outputDirectory) {
- this.original_directory = originalDirectory || path.join(FileHelpers.getRootDirectory(), "public");
- this.output_directory = outputDirectory || path.join(FileHelpers.getRootDirectory(), "public/test");
- }
-
- /**
- * Compares two sets of documentation
- * @param language Language which has to be compared.
- * @param version Version which files has to be compared.
- * @param verbose_mode Verbosity level.
- */
- DocsComparer.prototype.compare = function (language, version, verbose_mode) {
- var self = this,
- ignore_list = ['.', '..', '.DS_Store', 'test'];
-
- verbose_mode = verbose_mode || 0;
- if (verbose_mode > 0) {
- console.log("Comparing docs for lang " + language + " and version " + version);
- console.log("Clearing output directory");
- }
-
- fs.readdirSync(this.original_directory).forEach(function (language_dir) {
- if (ignore_list.indexOf(language_dir) !== -1) {
- return;
- }
-
- if (language && language_dir !== language) {
- return;
- }
-
- var language_path = path.join(self.original_directory, language_dir);
-
- fs.readdirSync(language_path).forEach(function (version_dir) {
- if (ignore_list.indexOf(version_dir) !== -1) {
- return;
- }
-
- if (version && version_dir !== version) {
- return;
- }
-
- var output_path = path.join(self.output_directory, language_dir, version_dir),
- input_path = path.join(self.original_directory, language_dir, version_dir),
- options = {
- lang: language_dir,
- version: version_dir,
- verbose: verbose_mode
- };
-
- console.log(" => Comparing the Cordova Documentation for " + version_dir + "-" + language_dir + "...");
- self.process(input_path, output_path, options);
- });
- });
- };
- DocsComparer.prototype.process = function (original_directory, output_path, options) {
- var self = this,
- compareFiles;
- console.log("Processing " + original_directory + " and " + output_path);
- compareFiles = function (fileName) {
- var relativePath = path.relative(original_directory, fileName),
- targetFile,
- originalFileStat,
- targetFileStat,
- originalFileSize,
- targetFileSize;
- targetFile = path.join(output_path, relativePath);
- if (!fs.existsSync(targetFile)) {
- console.error("Path " + relativePath + " is missing in the new docs");
- return;
- }
-
- if (/\.html$/.test(relativePath)) {
- // Compare HTML content.
- self.compareHtml(fileName, targetFile, relativePath, options);
- } else {
- originalFileStat = fs.statSync(fileName);
- targetFileStat = fs.statSync(targetFile);
- originalFileSize = originalFileStat.size;
- targetFileSize = targetFileStat.size;
- self.compareFileSize(fileName, targetFile, relativePath, options);
- }
- };
- processEachFile(original_directory, compareFiles, function (directoryName) {
- var relativePath = path.relative(original_directory, directoryName),
- targetFile;
- targetFile = path.join(output_path, relativePath);
- if (!fs.existsSync(targetFile)) {
- console.error("Dir " + relativePath + "/ is missing in the new docs");
- return;
- }
-
- // console.log(relativePath + "\\");
- return true;
- });
- };
-
- DocsComparer.prototype.compareHtml = function (sourceFile, targetFile, relativePath, options) {
- if (options.verbose > 0) {
- console.log("Compare " + relativePath);
- }
-
- if (relativePath === "_index.html") {
- if (options.lang === "zh" || options.lang === "ja" || options.lang === "ko" || options.lang === "ru") {
- console.log("File " + relativePath + " is skipped for the Asian languages and Russian, since this is results in out of memory exception");
- return;
- }
- }
-
- var cheerioOptions = {
- normalizeWhitespace: true,
- xmlMode: true
- },
- sourceDom = cheerio.load(fs.readFileSync(sourceFile), cheerioOptions),
- targetDom = cheerio.load(fs.readFileSync(targetFile), cheerioOptions);
-
- // This is identical subsets
- this.compareDomSubset(sourceDom, targetDom, "head", relativePath, options);
- this.compareDomSubset(sourceDom, targetDom, "#sidebar", relativePath, options);
- this.compareDomSubset(sourceDom, targetDom, "#header", relativePath, options);
- this.compareDomSubset(sourceDom, targetDom, "#content", relativePath, options);
-
- // Almost identical subsets
- this.compareDomSubset(sourceDom, targetDom, "#subheader", relativePath, options);
- };
-
- DocsComparer.prototype.compareDomSubset = function (sourceDom, targetDom, subset, relativePath, options) {
- var sourceHtml = sourceDom(subset).html(),
- targetHtml = targetDom(subset).html(),
- diff,
- changed = false;
-
- diff = jsdiff.diffChars(sourceHtml, targetHtml);
- diff.forEach(function (part) {
- changed = part.added || part.removed;
- });
- if (changed) {
- console.error("Subset of DOM '" + subset + "' for path " + relativePath + " is different.");
- if (options.verbose > 0) {
- diff.forEach(function (part) {
- // green for additions, red for deletions
- // grey for common parts
- var color = part.added ? 'green' : (part.removed ? 'red' : 'grey');
- process.stderr.write(part.value[color]);
- });
-
- console.log();
- }
- }
- };
-
- DocsComparer.prototype.compareDom = function (sourceDom, targetDom, relativePath, options) {
- var sourceHtml = sourceDom.html(),
- targetHtml = targetDom.html(),
- diff,
- changed = false;
-
- diff = jsdiff.diffChars(sourceHtml, targetHtml);
- diff.forEach(function (part) {
- changed = part.added || part.removed;
- });
- if (changed) {
- console.error("DOM for path " + relativePath + " is different.");
- if (options.verbose > 0) {
- diff.forEach(function (part) {
- // green for additions, red for deletions
- // grey for common parts
- var color = part.added ? 'green' : (part.removed ? 'red' : 'grey');
- process.stderr.write(part.value[color]);
- });
-
- console.log();
- }
- }
- };
-
- DocsComparer.prototype.compareFileSize = function (sourceFile, targetFile, relativePath) {
- var originalFileStat = fs.statSync(sourceFile),
- targetFileStat = fs.statSync(targetFile),
- originalFileSize = originalFileStat.size,
- targetFileSize = targetFileStat.size;
-
- if (originalFileSize !== targetFileSize) {
- console.error("Path " + relativePath + " is different. Old size: " + originalFileSize + ". New size: " + targetFileSize);
- }
-
- return originalFileSize !== targetFileSize;
- };
-
- return DocsComparer;
-}());
-module.exports = DocsComparer;
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org