Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

新增“读书报告”模板 #359

Merged
merged 28 commits into from
Aug 3, 2023
Merged

Conversation

YDX-2147483647
Copy link
Collaborator

@YDX-2147483647 YDX-2147483647 commented Jun 6, 2023

templates/增加reading-report/bithesis.dtx增加若干字段。

更改

  • 封面

    • 标题:“北京理工大学”下方写“本科生读书报告”。
    • 页眉:“北京理工大学本科生读书报告”。
    • 字段:上课学期、学院、学生姓名、学号、课程名称、任课教师。(和毕业设计差不少)
    • 如果读书报告不叫“读书报告”,可用style / head设置页眉文字,用style / headline设置封面文字。
  • README

  • BIThesis-wiki docs: Add reading-report BIThesis-wiki#106

    这里需要放 Overleaf 链接和图片,我不太方便改……文字我可以写个初稿。

    <ul><li>读书报告模板</li><li>包括封面,BIT logo</li><li>格式为简化版本科毕业设计</li><li>适用于信息与电子学院“电磁场与电磁波”等课程和一些公选课</li></ul>
  • cliff.toml之类的

    这些我不确定,比如CHANGELOG.md需要手动改吗?因为需要加一类 reading report。

问题

Resolves: #337


备用参考

- 移除多余章节
- 内容示例换为读书报告的要求
- 更正注释中名称
- 添加到 Makefile
- 更新 main.tex 中的选项

Relates-to: BITNP#337
@fky2015
Copy link
Contributor

fky2015 commented Jun 6, 2023

  • \BITSetupinfo / titleEn直接删除时,会显示默认的英文标题,而不是删除该项。

请通过传入空字符串删除该项

@YDX-2147483647
Copy link
Collaborator Author

YDX-2147483647 commented Jun 6, 2023

(我现在就是这么做的)

@fky2015
Copy link
Contributor

fky2015 commented Jun 6, 2023

不太建议直接增加一个 6 作为新的类别。原因是现在有大量代码会依赖 if else 的逻辑分别判断研究生和本科生模板。

@fky2015
Copy link
Contributor

fky2015 commented Jun 6, 2023

比较建议在 main.tex 层通过参数来自定义封面内容。为了达到这个目标,你可以对某一个模板封面进行改动,支持更多自定义参数。

@YDX-2147483647
Copy link
Collaborator Author

YDX-2147483647 commented Jun 6, 2023

唔,我加6的主要动机是更改封面“北京理工大学”下方标题。目前标题似乎是常量,我把它改到\BITSetup选项键值对可以吗?
图片


现已回退类别 6;标题还没改。

图片

@YDX-2147483647
Copy link
Collaborator Author

若把标题改到\BITSetup,需要每种模板有不同的默认值,这个现在能实现吗?

@fky2015
Copy link
Contributor

fky2015 commented Jun 7, 2023

若把标题改到\BITSetup,需要每种模板有不同的默认值,这个现在能实现吗?

这就是为啥当时定义了(但没使用) clist。有两种方式可以实现:

  1. 在 BITSetup 里面通过选择 clist 来初始化变量。(推荐)
  2. 在调用的时候调用一个 function,然后选择 clist。

@fky2015
Copy link
Contributor

fky2015 commented Jun 7, 2023

唔,我加6的主要动机是更改封面“北京理工大学”下方标题。目前标题似乎是常量,我把它改到\BITSetup选项键值对可以吗?

对,可以

@fky2015
Copy link
Contributor

fky2015 commented Jun 7, 2023

flowchart TD
    subgraph 加载 cls
    A
    X
    end

    subgraph 用户调用相关函数
    B
    Z
    end

    subgraph "\BITSetup (用户可以介入此过程)"
    Y
    end
    A[定义常量] --> B[使用常量]

    X[定义常量] --> Y["使用常量定义“常量变量”"]

    Y-->Z["使用“常量变量”"]
Loading

新旧常量方案比较⬆️

bithesis.dtx Outdated Show resolved Hide resolved
bithesis.dtx Show resolved Hide resolved
YDX-2147483647 added a commit to YDX-2147483647/BIThesis that referenced this pull request Jun 12, 2023
headline 原先叫 cover_title(有的也叫 title),可 title 也在封面出现,容易混淆。因此改成 headline 了。

- 论文标题`info / title`,由使用者指定。
- 页眉标题`style / head`,默认如“北京理工大学本科生毕业设计(论文)”。
- 封面论文标题、校徽之间大标题`style / headline`,默认如“本科生毕业设计(论文)”

此功能一般不用,因此未在`main.tex`的注释中提示。

Relates-to: BITNP#359
@YDX-2147483647
Copy link
Collaborator Author

YDX-2147483647 commented Jun 13, 2023

现在应该完成了。

截图

page 1

page 2

page 3

make regression-test结果和 #368 差不多,没有需要关注的变化。

问题

bithesis.cls应该怎么处理?现在除了 graduate-thesis,其它*.cls都被忽略了。

$ rg cls --glob **/.gitignore
templates\graduate-thesis\.gitignore
316:!*.cls

.gitignore
14:*.cls

@YDX-2147483647 YDX-2147483647 marked this pull request as ready for review June 13, 2023 04:57
@YDX-2147483647 YDX-2147483647 changed the title 新增“读书报告模板”模板 新增“读书报告”模板 Jun 13, 2023
@YDX-2147483647
Copy link
Collaborator Author

YDX-2147483647 commented Jun 22, 2023

现在还有几个问题,我列在 PR 最开头的描述了。能否解答一下?

  • Overleaf
  • cliff.toml
  • *.cls

@YDX-2147483647
Copy link
Collaborator Author

刚刚相对 v3.6.0-beta-10 回归测试了一下,没有任何差异。

@YDX-2147483647
Copy link
Collaborator Author

@fky2015 请问最近可以看一下吗?

@fky2015
Copy link
Contributor

fky2015 commented Jul 30, 2023

这些我不确定,比如CHANGELOG.md需要手动改吗?因为需要加一类 reading report。

是的。

@fky2015
Copy link
Contributor

fky2015 commented Jul 30, 2023

overleaf 和 封面的问题:
首先通过 ./scripts 里的脚本生成封面。然后通过 https://www.figma.com/file/knaYMcyxzUsx9z4IPyJFyi/BIThesis?type=design&node-id=0%3A1&mode=design&t=Ca0LxZ1QZkwmgrNT-1 替换封面内容,生成有阴影的封面图片。然后上传图床。

Copy link
Contributor

@fky2015 fky2015 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

没啥问题。另外长期来看,字体(版权)问题还是得解决。

YDX-2147483647 added a commit to YDX-2147483647/BIThesis-wiki that referenced this pull request Jul 31, 2023
Copy link
Contributor

@fky2015 fky2015 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fky2015 fky2015 added this pull request to the merge queue Aug 3, 2023
Merged via the queue into BITNP:main with commit fc8061b Aug 3, 2023
3 checks passed
@YDX-2147483647 YDX-2147483647 deleted the reading-report branch August 4, 2023 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] 读书报告模板
2 participants