lbt 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9da52e531926f42a9bb93585b0d04ff1a74f2de4db2f816793cdfa0812de12d
-  data.tar.gz: 67fe9f7f808e207a832dad8c6561eef93cd46110be4d92123884845cee2772e1
+  metadata.gz: a9cf39baff107d837fdd02c88764d3b161b9569cc3298b479917d44b371a3e63
+  data.tar.gz: 754274ca6ee26d3bccfe6b3f1c87621c73ef52bbf37190fc67b9d1cda430b931
 SHA512:
-  metadata.gz: 7b35e5b8d74c99d3e13d202e476a3b38a56b57bf3cd33836c3be01e8cff37380f4ddd2eabe06bf51eb31e551fd9c1efc352d847ebc037eb6213945cd69e4bb04
-  data.tar.gz: f07ce4110e54c2a5fb2490a35a8af103e508db5469cd616225ec53e82f7d38103682b9294726be0220346c7e336d92391426ed8450a1bbd21e7b0ba6c588a4e2
+  metadata.gz: 34a14917dc084b5185f7b688d089aed5dd3ac9e28b8805d132ebc61884e7c6739448f49ea482c77eb144502b9bc5f6cb7e0d3b2116939e667afca9dc9d8ca924
+  data.tar.gz: 7afad25c64d3bdd470c61015b090db21aebb527c1b1ffd3fb827a29f1b2642dea937ccf935b66c78de1101dd137af03f284f93f41e366beb613156e989f2a884

data/README.md

@@ -2,15 +2,15 @@
 
 # LaTeX Build Tools
 
-LaTeX Build Tools is a tool to maintain big LaTeX source files.
-This version is different from the old versions as follows.
+LaTeX Build Tools is a tool to manage big LaTeX source files.
+This version is different from the old versions.
 
 - Use `lbt` command to run every sub commands.
-- It is provided as a gem.
+- It is provided as a gem, which is a Ruby library program.
 
 The old versions, the one with rake and the other of bash scripts, are moved to the other branches, `rake_version` and `bash` respectively.
 
-LaTeX Build Tools supports `lualatex` engine only.
+LaTeX Build Tools supports LuaLaTeX engine only.
 If you want to use another engine, you need to modify `lib/lbt/build.rb` and `lib/lbt/part_typeset.rb`.
 
 ## Prerequisite
@@ -37,11 +37,11 @@ If you want to install it from the source code, do the following.
 2. Unzip the downloaded Zip file, then a new directory `LaTeX-BuildTools-master` will be created.
 3. Type `gem build lbt` under the directory, then the gem file `lbt-X.X.X.gem` is created.
 The number `X.X.X` is the version number like `0.5.2`.
-1. Type `gem install lbt-X.X.X.gem`.
+1. Type `gem install lbt-X.X.X.gem`, where `X.X.X` is the version number.
 
 ## Document
 
-See [Tutorial](Tutorial.md).
+See [Tutorial.en](https://toshiocp.github.io/LaTeX-BuildTools/Tutorial_en_md.html).
 
 ## License
 
@@ -51,16 +51,16 @@ GPL. See [License.md](License.md).
 
 # LaTeX Build Tools
 
-LaTeX Build Toolsは大きなLaTeXソースファイルを管理するためのツールである。
-現在の版は次の2点が旧版と異なっている。
+LaTeX Build Toolsは大きなLaTeXソースファイルを管理するためのツールです。
+現在の版は次の2点が旧版と異なっています。
 
 - lbtというコマンドからすべてを起動
-- gemとして提供される
+- gem（Rubyのライブラリ・プログラム）として提供される
 
-旧版の、rakeを用いる版とbashスクリプト版は、それぞれ`rake_version`ブランチと`bash`ブランチに移動した。
+旧版の、rakeを用いる版とbashスクリプト版は、それぞれ`rake_version`ブランチと`bash`ブランチに移動しました。
 
-LaTeX Build ToolsがサポートするLaTeXエンジンはlualatexである。
-その他のエンジンを使いたい場合は`lib/lbt/build.rb`と`lib/lbt/part_typeset.rb`の修正が必要である。
+LaTeX Build ToolsがサポートするLaTeXエンジンはLuaLaTeXです。
+その他のエンジンを使いたい場合は`lib/lbt/build.rb`と`lib/lbt/part_typeset.rb`の修正が必要です。
 
 ## 動作条件
 
@@ -86,11 +86,11 @@ $ gem install lbt
 2. ZIPファイルを解凍すると`LaTeX-BuildTools-master`というディレクトリが作られる
 3. 端末をそのディレクトリに移動して`gem build lbt`とタイプすると、`lbt-X.X.X.gem`というGemファイルが作られる。
 この中の`X.X.X`はバージョン番号で、例えば`0.5.2`などのようなものである
-4. `gem install lbt-X.X.X.gem`とタイプしてインストールする
+4. `gem install lbt-X.X.X.gem`とタイプしてインストールする（`X.X.X`はバージョン番号）
 
 ## ドキュメント
 
-[チュートリアル](Tutorial.ja.md)を参照してほしい。
+使い方の説明は[Tutorial.ja](https://toshiocp.github.io/LaTeX-BuildTools/Tutorial_ja_md.html)を参照してほしい。
 
 ## ライセンス
 

data/Tutorial.en.md

@@ -131,4 +131,30 @@ If you want to renamed these (sec1.md, sec1.5.md and sec2.md) into consecutive n
 
 ```
 $ lbt renum
-```
+```
+
+# Pandoc and Top-Level-Division option
+
+Lbt uses Pandoc to convert Markdown to LaTeX.
+The default behavior of Pandoc is from the ATX-heading `#` to `\section`.
+See `--top-level-division` option in the Pandoc document.
+
+You can change it by modifying `.config` file in your LaTeX-file directory.
+For example, the following makes the conversion from `#` to `\chapter`.
+
+```
+$ cat .config
+build_dir = _build
+top-level-division = chapter
+```
+
+The format is `top-level-division = (part, chapter or section)`.
+
+The table shows the commonly used top-level-division.
+
+|documentclass|top level division|
+|:-----|:-----|
+|book|chapter or part|
+|report|chapter|
+|article|section|
+|beamer|section|

data/Tutorial.ja.md

@@ -126,3 +126,30 @@ renumサブコマンドを実行することでリナンバーできます。
 ```
 $ lbt renum
 ```
+
+# Pandoc と Top-Level-Division オプション
+
+LbtはPandocを用いてMarkdownをLaTeXに変換しています。
+デフォルトでは、PandocはATX見出しの`#`を`\section`に変換します。
+詳しくはPandocのドキュメントの`--top-level-division`を参照してください。
+
+これを、LaTeXファイルのディレクトリにある`.config`ファイルを書き換えることで変更できます。
+例えば、下記のようにすると、`#`が`\chapter`に対応するようになります。
+
+```
+$ cat .config
+build_dir = _build
+top-level-division = chapter
+```
+
+書き方の書式は`top-level-division = (part, chapter or section)`です。
+
+下記の表は一般的に良く用いられるtop-level-divisionです。
+
+|documentclass|top level division|
+|:-----|:-----|
+|book|chapter or part|
+|report|chapter|
+|article|section|
+|beamer|section|
+

data/lib/lbt/build.rb

@@ -3,8 +3,8 @@ require_relative 'utils.rb'
 module Lbt
   # Typeset LaTeX source files into a PDF file.
   def build
-    m = File.read(".config").match(/^build_dir = (.*)$/)
-    build_dir = m[1] ? m[1] : "_build"
+    m = get_config[:'build_dir']
+    build_dir = m ? m : "_build"
     raise "main.tex not exist." unless File.exist?('main.tex')
     mkdir build_dir unless Dir.exist?(build_dir)
 

data/lib/lbt/part_typeset.rb

@@ -16,8 +16,8 @@ module Lbt
       return unless File.file? file
     end
 
-    m = File.read(".config").match(/^build_dir = (.*)$/)
-    build_dir = m[1] ? m[1] : "_build"
+    m = get_config[:'build_dir']
+    build_dir = m ? m : "_build"
     raise "main.tex not exist." unless File.exist?('main.tex')
     mkdir build_dir unless Dir.exist?(build_dir)
 

data/lib/lbt/utils.rb

@@ -105,9 +105,17 @@ If the files are as above, the PCS instance keeps the six filenames whch are sor
     end
   end
 
+  # Convert '.config' file into a Hash
+  def get_config
+    return {} unless File.exist?(".config")
+    File.read(".config").split(/\n/).map{|s| s.split('=')}.map{|key, val| [key.strip.to_sym, val.strip]}.to_h
+  end
+
   # Return a hash (key: extension, value: Proc object) of converters.
   def get_converters
-    converters = {'.md':  lambda {|src, dst| system("pandoc -o #{dst} #{src}")} }
+    tld = get_config[:'top-level-division']
+    tld = tld ? tld : "default"
+    converters = {'.md':  lambda {|src, dst| system("pandoc --top-level-division=#{tld} -o #{dst} #{src}")} }
     if File.file?("converters.rb")
       c = eval(File.read("converters.rb"))
       c.each {|key, val| converters[key] = val} if c.is_a?(Hash)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lbt
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Toshio Sekiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-19 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies: []
 description: Lbt is a build tool for LaTeX. It is useful for big documents.
 email: lxboyjp@gmail.com
@@ -35,7 +35,8 @@ files:
 homepage: https://github.com/ToshioCP/LaTeX-BuildTools
 licenses:
 - GPL-3.0
-metadata: {}
+metadata:
+  documentation_uri: https://toshiocp.github.io/LaTeX-BuildTools/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -51,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: LaTeX Build Tools