diff --git a/README.md b/README.md index eefa21b..25a884c 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,55 @@ -# C89-FirstStepReVIEW-v2 +# FirstStepReVIEW-v3 -「技術書をかこう！〜はじめてのRe:VIEW〜改訂版」はRe:VIEW 2.3.0に対応した執筆ノウハウ本です。 +「技術書をかこう！〜はじめてのRe:VIEW〜第3版」はRe:VIEW 5.8に対応した執筆ノウハウ本です。 Re:VIEWの使い方と制作にあたっての企画〜執筆〜編集〜告知〜会場頒布までのノウハウをギュッと詰めています。 -またTechBoosterが利用してる書籍レイアウト（B5/A5/電子書籍）は[ReVIEW-Templateリポジトリ](https://github.com/TechBooster/ReVIEW-Template)で公開しています + +本リポジトリやTechBoosterが利用してる書籍のレイアウト（B5/A5/電子書籍）は[ReVIEW-Templateリポジトリ](https://github.com/TechBooster/ReVIEW-Template)で公開しています。 ## 本を読むには？ ### 電子書籍として閲覧する場合 -https://techbooster.booth.pm/ -でPDF版の販売予定があります + * https://techbooster.booth.pm/ + +ここでPDF版を販売しています。 ### 物理本がほしい場合 -ComicZinさんにて委託を予定してます +技術書典15で販売を予定しています。 ## この本のビルドの仕方 +CloneしてGitHub Actions経由で出力するのが、たぶん一番楽です。 -細かい準備(TeX入れたり)は[Setup方法](https://github.com/TechBooster/C89-FirstStepReVIEW-v2/blob/9ecb665f38ffb54c8943fb0406e3fe2bd9bc5e40/articles/setup.re)に準じます。 - -TeXの導入をしない場合でもHTML出力は可能です。Dockerコンテナでビルドすることもできます。 +こまかなビルド環境の準備は[Setup方法](https://github.com/TechBooster/FirstStepReVIEW-v3/blob/main/articles/setup.re)に準じます。 +Dockerコンテナでビルドする場合、ローカルでの環境は最低限で大丈夫です。 -### PDF出力する - -rbenvやnodebrewを利用してRubyやNode.jsの準備をしている前提です。 -もしそうではない場合、適宜sudoを補うこと。 -Node.jsは4.x系以上が必須です。 - -graphvizを使ったのでbrew install graphvizとかが必要かもしれません。 - -``` -$ gem install bundler -$ git clone git@github.com:TechBooster/C89-FirstStepReVIEW-v2.git -$ cd C89-FirstStepReVIEW-v2 -$ npm install -$ npm run pdf -``` - -### Dockerを使う +### Dockerを使ってPDF出力する TeXの環境構築が困難な場合、一式セットアップ済みの[dockerイメージ](https://registry.hub.docker.com/u/vvakame/review/)を用意してあるので使ってください。 Dockerがうまく動くようになっている場合、以下のコマンドで細かい準備なしにビルドを行うことができます。 ``` -$ docker pull vvakame/review +$ docker pull vvakame/review:5.8 $ ./build-in-docker.sh ``` -### HTML出力 +### ローカル環境でPDF出力する -`npm run web` を実行すると、`publish/`ディレクトリ以下に公開用HTMLファイルおよびcss,画像を出力します。 +rbenvやnodebrewを利用してRubyやNode.jsの準備をしている前提です。 +もしそうではない場合、適宜sudoを補うこと。 -### 権利 +``` +$ gem install bundler +$ git clone https://github.com/TechBooster/FirstStepReVIEW-v3.git +$ cd FirstStepReVIEW-v3 +$ npm install +$ npm run pdf +``` +## 権利 * 文章、イラストデータについては著作物の権利を権利者に留保します * 権利者はGitHubの利用規約に基づき、リポジトリのForkに同意しています * 文章、イラストデータの流用、改変は許可していません（利用したい場合はIssue等でお問い合わせください） - * 設定ファイル、テンプレートなど制作環境（techbooster-doujin.styなど）はMITライセンスです + * 設定ファイル、テンプレートなど制作環境（techbooster-doujin-base.styなど）はMITライセンスです * 再配布などMITライセンスで定める範囲で権利者表記をおねがいします * 本設定を使って生成した書籍は現段階のRe:VIEWではソフトウェアたりえません。したがってライセンスは発生しません（あとがきなどへの表記はあると嬉しいものの生成物での表記は不要です） diff --git a/articles/config-ebook.yml b/articles/config-ebook.yml index 663a606..26da48d 100644 --- a/articles/config-ebook.yml +++ b/articles/config-ebook.yml @@ -8,7 +8,7 @@ inherit: ["config.yml"] # 電子版を別のファイル名にしたい場合 -# bookname: C89-FirstStepReVIEW-v2-ebook +# bookname: FirstStepReVIEW-v3-ebook # B5の設定(10pt 40文字×35行) - 電子版 texdocumentclass: ["review-jsbook", "media=ebook,paper=b5,serial_pagination=true,openany,fontsize=10pt,baselineskip=15.4pt,line_length=40zw,number_of_lines=35,head_space=30mm,headsep=10mm,headheight=5mm,footskip=10mm"] diff --git a/articles/config.yml b/articles/config.yml index 05c909e..ebc0ee4 100644 --- a/articles/config.yml +++ b/articles/config.yml @@ -92,7 +92,7 @@ rights: (C) 2017-2023 TechBooster debug: null # 固有IDに使用するドメイン。省略した場合は時刻に基づくランダムUUIDが入る -urnid: urn:uid:https://github.com/TechBooster/C89-FirstStepReVIEW-v2 +urnid: urn:uid:https://github.com/TechBooster/FirstStepReVIEW-v3 # # ISBN。省略した場合はurnidが入る # isbn: null diff --git a/articles/configure.re b/articles/configure.re index 7d243c9..965bc32 100644 --- a/articles/configure.re +++ b/articles/configure.re @@ -102,7 +102,7 @@ history: [["2015-12-31 C89版 v1.0.0"],["2017-8-11 C92版 v2.0.0"],["2023-11-12 rights: (C) 2017-2023 TechBooster # 固有IDに使用するドメイン。省略した場合は時刻に基づくランダムUUIDが入る -urnid: urn:uid:https://github.com/TechBooster/C89-FirstStepReVIEW-v2 +urnid: urn:uid:https://github.com/TechBooster/FirstStepReVIEW-v3 # 目次として抽出する見出しレベル toclevel: 2 diff --git a/articles/setup.re b/articles/setup.re index a2c5136..a0e2ca1 100644 --- a/articles/setup.re +++ b/articles/setup.re @@ -140,12 +140,12 @@ TechBoosterが提供しているReVIEW-templateリポジトリをベースに執 * @{https://github.com/TechBooster/ReVIEW-Template} #@# prh:disable -Docker実行用のスクリプトは@{C89-FirstStepReVIEW-v2}などプロジェクトルートから実行します（直下に@{articles}ディレクトリがあることを確認してください）。 +Docker実行用のスクリプトは@{FirstStepReVIEW-v3}などプロジェクトルートから実行します（直下に@{articles}ディレクトリがあることを確認してください）。 #@# prh:disable //cmd{ $ pwd -/Users/mhidaka/repos/C89-FirstStepReVIEW-v2 +/Users/mhidaka/repos/FirstStepReVIEW-v3 $ ./build-in-docker.sh //} @@ -160,7 +160,7 @@ PDFファイルは@{articles/}ディレクトリの下に@{書籍名.pdf スクリプトファイルのなかでRe:VIEWの設定ファイル@{articles/config.yml}を指定しています。処理を変えたいなど中身を知りたい場合は、本書のリポジトリにある@{build-in-docker.sh}を参照してください。 #@# prh:disable - * @{https://github.com/TechBooster/C89-FirstStepReVIEW-v2/blob/master/build-in-docker.sh} + * @{https://github.com/TechBooster/FirstStepReVIEW-v3/blob/main/build-in-docker.sh} スクリプトを使わず@{docker}コマンドを手で打ち込んで実行する場合は次のコマンドです。 diff --git a/articles/textlint.re b/articles/textlint.re index 8d4f62a..7d6c391 100644 --- a/articles/textlint.re +++ b/articles/textlint.re @@ -139,7 +139,7 @@ Visual Studio Codeを起動し、サイドバーの上部にマーケットプ === prhで校正する #@# prh:disable -インストール後は本書のリポジトリを開いて試してみてください。@{メニュー > フォルダを開く}からC89-FirstStepReVIEW-v2ディレクトリを対象とするとわかりやすいでしょう。 +インストール後は本書のリポジトリを開いて試してみてください。@{メニュー > フォルダを開く}からFirstStepReVIEW-v3ディレクトリを対象とするとわかりやすいでしょう。 @{articles/prh.yml}ファイルがTechBoosterの設定ファイル@{prh_setting}です。prhによる校正はターミナルに表示します（@{vscode-prh-warning}）。 //footnote[prh_setting][@{https://github.com/prh/rules/blob/a05c35d285d08dc7ba0a78dd791160116d39e9f4/media/techbooster.yml}] diff --git a/articles/tips.re b/articles/tips.re index ba20171..3615232 100644 --- a/articles/tips.re +++ b/articles/tips.re @@ -364,7 +364,7 @@ TechBoosterではNode.js+npm-scripts（裏はgrunt）を利用しています。 #@# prh:disable //emlist{ -rm -rf articles/C89-FirstStepReVIEW-v2-pdf/ \ +rm -rf articles/FirstStepReVIEW-v3/ \ articles/*.pdf \ articles/*.epub \ articles/*.html \ @@ -374,7 +374,7 @@ rm -rf articles/C89-FirstStepReVIEW-v2-pdf/ \ #@# prh:disable それぞれ@{--debug}オプション付きでpdfをビルドしたときのtmpディレクトリ、pdf、epub、html、idgxml（Adobe InDesign用XML）、text生成時に作成される一時ファイルまたは最終出力ファイルです。 -一番最初の行のC89-FirstStepReVIEW-v2-pdf部分は@{articles/config.yml}の@{bookname}の設定により変化します。 +一番最初の行のFirstStepReVIEW-v3部分は@{articles/config.yml}の@{bookname}の設定により変化します。 * @{review-preproc}コマンドを実行する @@ -424,7 +424,7 @@ PDF、EPUBについては利用するコマンドそのものが違うので注 これらを詰め込んだ、実際にTechBoosterで使っているgrunt用設定ファイルを公開しています。 #@# prh:disable - * @{https://github.com/TechBooster/C89-FirstStepReVIEW-v2/blob/master/Gruntfile.js} + * @{https://github.com/TechBooster/FirstStepReVIEW-v3/blob/main/Gruntfile.js} Node.jsのバージョンといった動作条件はリポジトリのメンテナンスなどで更新があります。利用前にリポジトリを確認してください。 diff --git a/articles/writing-book.re b/articles/writing-book.re index 7c72091..45dc176 100644 --- a/articles/writing-book.re +++ b/articles/writing-book.re @@ -110,7 +110,7 @@ Re:VIEWは優れた書籍制作ツールですが、そのままでは入稿で #@# prh:disable : 本書のリポジトリ - @{https://github.com/TechBooster/C89-FirstStepReVIEW-v2} + @{https://github.com/TechBooster/FirstStepReVIEW-v3} : テンプレートリポジトリ @{https://github.com/TechBooster/ReVIEW-Template} diff --git a/package.json b/package.json index 283c681..0418e73 100644 --- a/package.json +++ b/package.json @@ -1,19 +1,19 @@ { - "name": "c89-firststepreview-v2", + "name": "firststepreview-v3", "version": "0.0.3", "private": true, "description": "", "main": "Gruntfile.js", "repository": { "type": "git", - "url": "git+https://github.com/TechBooster/C89-FirstStepReVIEW-v2.git" + "url": "git+https://github.com/TechBooster/FirstStepReVIEW-v3.git" }, "author": "TechBooster(mhidaka)", "license": "UNLICENSED", "bugs": { - "url": "https://github.com/TechBooster/C89-FirstStepReVIEW-v2/issues" + "url": "https://github.com/TechBooster/FirstStepReVIEW-v3/issues" }, - "homepage": "https://github.com/TechBooster/C89-FirstStepReVIEW-v2#readme", + "homepage": "https://github.com/TechBooster/FirstStepReVIEW-v3#readme", "engines": { "node": ">=6.0.0" }, diff --git a/qr-generator/qr-generator.sh b/qr-generator/qr-generator.sh index bb1d718..c002e84 100644 --- a/qr-generator/qr-generator.sh +++ b/qr-generator/qr-generator.sh @@ -4,7 +4,7 @@ export BOOK_DIR=../articles # 書籍PDFファイル名、書籍タイトル、ID開始番号をここで調整 # これらは、それぞれ空白で区切って複数指定可 -export BOOKS=("C89-FirstStepReVIEW-v2.pdf") +export BOOKS=("FirstStepReVIEW-v3.pdf") export TITLES=("技術書をかこう！～はじめてのRe:VIEW～") export IDSTARTS=(10000)