Skip to content

"Short title" option for the Section class #380

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.

Sign up for GitHub

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

Open
skimprem wants to merge 7 commits into
base: master
Choose a base branch
from
Open

"Short title" option for the Section class #380

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3743212
Add "short title" option to Section class
skimprem Jan 3, 2024
3384a97
Fix short in section
Jan 3, 2024
045a116
Merge branch 'master' into master
JelteF Jul 23, 2024
1b39b4a
Merge branch 'master' into master
JelteF Jul 23, 2024
a4040cd
Merge branch 'master' into master
skimprem Jul 25, 2024
584d6de
Update section.py
skimprem Jul 25, 2024
f64a7de
Update section.py
skimprem Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions pylatex/section.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,23 @@ class Section(Container):
#: subclasses will also have the new default.
numbering = True

def __init__(self, title, numbering=None, *, label=True, **kwargs):
def __init__(self, title, numbering=None, *, short=None, label=True, **kwargs):
"""
Args
----
title: str
The section title.
numbering: bool
Add a number before the section title.
short: str
The short section title.
label: Label or bool or str
Can set a label manually or use a boolean to set
preference between automatic or no label
"""

self.title = title
self.short = short

if numbering is not None:
self.numbering = numbering
Expand Down Expand Up @@ -71,7 +74,7 @@ def dumps(self):
else:
num = ""

string = Command(self.latex_name + num, self.title).dumps()
string = Command(self.latex_name + num, self.title, self.short).dumps()
if self.label is not None:
string += "%\n" + self.label.dumps()
string += "%\n" + self.dumps_content()
Expand Down