├── .github
└── workflows
│ └── publish.yml
├── CHANGELOG.md
├── LICENSE
├── README.assets
├── attrsetting.png
├── clickhelp.png
├── clickhelp_en.png
├── setattrhint2.png
└── taskListId.png
├── README.md
├── README_en_US.md
├── icon.png
├── index.html
├── preview.png
├── release.py
├── src
├── API.js
├── common.js
├── config.js
├── progressMain.js
└── uncommon.js
├── static
├── holiday.json
├── icon.png
├── iconSetting.png
├── jquery-3.6.0.min.js
├── jscolor.js
├── layDate-v5.3.1
│ ├── laydate.js
│ └── theme
│ │ └── default
│ │ ├── font
│ │ ├── iconfont.eot
│ │ ├── iconfont.svg
│ │ ├── iconfont.ttf
│ │ └── iconfont.woff
│ │ └── laydate.css
└── progressbar.css
└── widget.json
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
1 | name: Create Release
2 |
3 | on:
4 | push:
5 | tags:
6 | - 'v*'
7 |
8 | permissions:
9 | contents: write
10 |
11 | jobs:
12 | build:
13 | runs-on: ubuntu-latest
14 | steps:
15 | - name: Checkout code
16 | uses: actions/checkout@v2
17 |
18 | - name: Generate Package.zip
19 | run: find . -not -path '*/\.*' -print | xargs zip package.zip
20 |
21 |
22 | - name: Set up Python
23 | uses: actions/setup-python@v2
24 | with:
25 | python-version: '3.8'
26 |
27 | - name: Get CHANGELOGS
28 | run: python release.py
29 |
30 | - name: Pre Release
31 | uses: softprops/action-gh-release@v1
32 | if: contains(github.ref, 'beta') || contains(github.ref, 'alpha')
33 | with:
34 | body_path: ./result.txt
35 | files: package.zip
36 | prerelease: true
37 | token: ${{ secrets.GITHUB_TOKEN }}
38 |
39 | - name: Release
40 | uses: softprops/action-gh-release@v1
41 | if: ${{ ! contains(github.ref, 'beta') && ! contains(github.ref, 'alpha') }}
42 | with:
43 | body_path: ./result.txt
44 | files: package.zip
45 | prerelease: false
46 | token: ${{ secrets.GITHUB_TOKEN }}
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | ## 更新日志
2 |
3 | ### v0.2.1 (2024年12月3日)
4 |
5 | - 改进:同步2025年法定节假日安排;
6 | - 改进:修改了部分由相对字体大小指定的宽度、高度;
7 |
8 | ### v0.2.0 (2024年7月10日)
9 |
10 | - 新增:删除其他挂件;
11 | 如果不再使用挂件,可快速移除位于当前工作空间的其他“任务进度条”挂件;
12 | - 新增:仅工作日(计算剩余时间时,跳过法定节假日与周末(补班除外));
13 | - 改进:周进度的周数计算:改为调API获得ISOWeek;
14 | - 改进:使用临近的任务列表块id快速填充“任务列表块id”;
15 | - 改进:使用快捷键打开设置(`Ctrl+I`),刷新/保存(`F5`);
16 |
17 | ### v0.1.7 (2024年3月13日)
18 | - 修复:自动模式在换用API计算进度时,错误地展开了设置区的问题;
19 | - 修复:减少错误日志输出;
20 |
21 | ### v0.1.6
22 | - 改进:避免fetch error错误输出;
23 |
24 | ### v0.1.4 (2023年5月24日)
25 | - 修复: 手动模式无法使用的问题;
26 | - 修复: 设定不显示按钮后,载入时闪现按钮的问题;
27 |
28 | ### v0.1.3 (2023年5月23日)
29 |
30 | - 改进:时间模式改进:
31 | - 时间模式显示;
32 | - 剩余天数颜色变化;
33 | - 开始结束时间选择控件([layDate](https://layuiweb.com/laydate/index.htm));
34 | - 时间设置为日期时,以天为单位计算进度;
35 | - 时间模式预设:天进度、周进度、月进度、年进度;
36 | - 改进:自动模式显示截止日期和剩余天数;
37 | - 改进:支持手动重设挂件高度;
38 |
39 | ### v0.1.2 (2022年12月22日)
40 |
41 | - 改进:时间模式时间段输出显示文案,支持显示相隔日期;
42 | - 新增:(beta)支持从`widgets/custom.js`导入用户设置,避免升级后设置丢失;
43 | - 改进:默认隐藏右侧的刷新和设置按钮;
44 | - 改进:除首次插入外,不再重设挂件宽高;
45 |
46 | ### v0.1.1 (2022年10月17日)
47 |
48 | - 修复:子项包括无序列表时,错误计算任务总数的问题;[#5](https://github.com/OpaqueGlass/progressBarT-sywidget/issues/5)
49 |
50 | ### v0.1.0 (2022年10月2日)
51 |
52 | - 新增:支持自动定位紧邻的任务列表块;
53 | - 改进:支持在挂件中设置属性、外观;
54 | - 改进:外观变更,将提示词移动至设置区(时间模式除外),减少视觉干扰;
55 | - 修复:进度条内部#process溢出问题;
56 |
57 | ### v0.0.1
58 |
59 | 从这里开始。
60 |
61 | - 自动模式
62 | - DOM模式支持观察任务列表变化,当任务列表发生新增、删除时自动计算进度;(在未来的软件更新中可能不再适用)
63 | - 支持Fn按钮设定任务全为未完成;
64 | - 手动模式
65 | - 支持点击、拖拽设定进度;
66 | - 时间模式
67 | - 支持计算时间进度;
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.assets/attrsetting.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/README.assets/attrsetting.png
--------------------------------------------------------------------------------
/README.assets/clickhelp.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/README.assets/clickhelp.png
--------------------------------------------------------------------------------
/README.assets/clickhelp_en.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/README.assets/clickhelp_en.png
--------------------------------------------------------------------------------
/README.assets/setattrhint2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/README.assets/setattrhint2.png
--------------------------------------------------------------------------------
/README.assets/taskListId.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/README.assets/taskListId.png
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## progress Bar T 进度条
2 |
3 | > 展示进度条的思源笔记挂件。
4 |
5 | - “自动”模式:绑定任务列表,计算任务列表第一层级完成进度;[^1]
6 | - 手动模式:鼠标拖拽/点击设定进度;
7 | - 时间模式:显示时间段进度;
8 |
9 | > 当前版本: v0.2.1
10 | > **改进**:“仅工作日”功能更新2025年法定节假日安排;
11 | > **改进**:修改了部分由相对字体大小指定的宽度、高度,保证编辑器字号非默认时的挂件宽高;
12 | >
13 | > 详见更新日志CHANGELOG.md;[更新日志](CHANGELOG.md) ;
14 |
15 | > 挂件最初在2022年9月发布,感谢陪伴!现已进入维护阶段,停止功能新增;如遇bug缺陷请反馈。
16 |
17 | ## 快速开始(必读)
18 |
19 | - 操作:
20 | - 单击进度条右侧的文字:刷新/手动模式保存;
21 | - 双击进度条右侧的文字:显示或隐藏设置;
22 | - 自动模式仅能统计挂件紧邻的列表或手动设定的列表;
23 | - (隐藏进度条右侧文字时,请点击显示进度百分比的文字);
24 |
25 | 
26 |
27 | 
28 | - 操作成功提示:
29 | - 成功刷新时,进度百分比将显示上划线;
30 | - 成功保存时,进度百分比将显示下划线;
31 | - 时间模式:
32 | - 点击日历图标可使用日历选择器选择日期;
33 | - 手动输入时间模式日期时,需要满足`年月日时分之间用非数字的字符隔开`的条件,例:`2023年4月14日`、`23:23`;
34 | - 其他常见问题:
35 | - 文档打开时挂件高度由长变短,影响体验?
36 | 点击“重设挂件高度”按钮或手动拖拽保存一下高度;
37 |
38 | > 强烈建议完整阅读此文档
39 |
40 | ## 设置&使用方式
41 |
42 | ### 模式说明
43 |
44 | #### 自动模式
45 |
46 | 默认情况下(任务列表块id为空时),挂件将自动获取**下方紧邻的**任务列表块并计算其进度。(若下方没有任务列表块,则获取挂件上方紧邻的任务列表块)
47 |
48 | > (非必需,仅在浮窗等情况下需要)使用左侧的填充图标可以快速填充临近的任务列表块id;
49 |
50 | 您也可以复制已经存在的任务列表块id(不是列表项块)到设置->任务列表块id中,点击“保存设置”按钮在挂件中应用更改。
51 |
52 | 
53 |
54 | 
55 |
56 | 自动模式下,双击`Fn`按钮(需要点开设置才能看到):取消/完成块id对应的**全部**任务列表项。
57 |
58 | > 鼠标悬停在刷新按钮上,有`(API)`标注时,无法在修改任务列表块后自动刷新,需要手动点击刷新按钮计算进度。
59 |
60 | #### 手动模式
61 |
62 | 点击进度条对应位置设定进度,然后点击刷新按钮保存进度,默认将在手动更改后0.5秒自动保存。
63 |
64 | 进度百分比下方出现下划线并随后消失,表明已经成功保存设定,请确定保存成功后再关闭文档。
65 |
66 | #### 时间模式
67 |
68 | 设置开始时间、结束时间,然后点击“保存设置”按钮。
69 |
70 | **挂件接受的时间字符串格式**为:(年、月、日、时、分之间需要使用任意的非数字字符隔开,小时为24小时制)
71 |
72 | - `yyyy MM dd`(年 月 日),例如`2020.1.1` `2020年1月1日`
73 | - `yyyy MM dd HH mm` (年 月 日 时 分),例如`2020.1.1 12.20`
74 | - `HH mm`(将在计算进度时自动补全为挂件运行时当天对应时间,用于展示当天进度),例如`12.20` `12:20`
75 |
76 | > 若为20xx年,年份数字可只写后两位。
77 |
78 | 请注意:时间模式下,进度刷新频率由`config.js`设定(请参考自定义设置),默认10分钟刷新一次;
79 |
80 | ### 自定义设置
81 |
82 | 打开`${思源data目录}/widgets/progressBarT/static/progressbar.css`,可编辑进度条显示样式,例如:
83 |
84 | - ~~进度条默认颜色;~~ 请注意,进度条颜色设定迁移至config.js设置;
85 | - 按钮样式,等;
86 |
87 | #### 在`config.js`中直接更改设置
88 |
89 | 打开`${思源data目录}/widgets/progressBarT/src/config.js`,可进行自定义设置,请参考设置项旁边的说明。以下是一些可能常用的设置项:
90 |
91 | - 手动模式操作后自动保存延迟`saveAttrTimeout`;
92 | - 自动模式API统计时自动计算间隔`refreshInterval`;
93 | - 自定义挂件属性名称`manualAttrName`、`autoTargetAttrName`、`startTimeAttrName`、`endTimeAttrName`等;
94 | - 自动模式:如果块不存在则创建块`createBlock`;
95 | - 时间模式:定时刷新间隔`timeModeRefreshInterval`;
96 | - 显示进度条右侧的刷新和设置按钮`showButtons`;
97 | - 挂件在各种情况下的宽高`widgetTimeModeHeight`、`widgetAutoModeWithTimeRemainHeight`、`widgetTimeModeHeight`、`widgetHeight`;
98 |
99 | #### 在`custom.js`中覆盖设置
100 |
101 | > 测试中,可能存在缺陷。
102 |
103 | 创建或编辑`${思源data目录}/widgets/custom.js`,仅支持`config.js`文件中defaultAttr(创建挂件时的默认设置)、setting(全局设置)下的设置项,以下是一个示例。
104 |
105 | ```javascript
106 | /*方案1:若之前有config,需要添加progressBarT的部分*/
107 | export const config = {
108 | token: "",
109 | progressBarT:{/*若之前有config,则只加入progressBarT的部分*/
110 | setting: { // 和config.js中setting对应
111 | showButtons: true
112 | },
113 | defaultAttr: {// 和config.js 中 defaultAttr对应
114 | frontColor: "rgba(255, 255, 255, 1)", //前景色更改
115 | barWidth: 12, //进度条宽度
116 | frontColorSelector: {//前景色颜色选择器配置(jscolor),像这样复杂的设置项,如果有更改,必须重新自定义全部属性,不能只自定义部分属性
117 | value: 'rgba(51,153,255,0.5)',
118 | position: 'bottom',
119 | height: 80,
120 | backgroundColor: '#333',
121 | palette: 'rgba(0,0,0,0) #2da44eff #f1993eff #0080cfff #cb406cff #ff5454ff #af481bff #269affff',//预设颜色组
122 | paletteCols: 11,
123 | hideOnPaletteClick: true
124 | },
125 | }
126 | }
127 | /*...其他挂件的自定义设置*/
128 | };
129 | ```
130 |
131 | ```javascript
132 | /*方案2 单独配置export*/
133 | export const progressBarT = {
134 | setting: { // 和config.js中setting对应
135 | showButtons: true
136 | },
137 | defaultAttr: {// 和config.js 中 defaultAttr对应
138 | frontColor: "rgba(255, 255, 255, 1)", //前景色更改
139 | barWidth: 12 //进度条宽度
140 | }
141 | }
142 | ```
143 |
144 | #### 节假日信息
145 |
146 | v0.2.0新增了在计算任务进度时“智能”地跳过中国法定节假日以及周末,目前挂件使用的法定节假日数据请悬停在“仅工作日”处查看,或直接参考:`./static/holiday.json`。
147 |
148 | 如果节假日未能涵盖实际假期,又或者需要使用其他地区的节假日信息,请创建`思源工作空间目录/data/storage/progressBarT/holiday.json`(优先生效),具体格式请参考`./static/holiday.json`。
149 |
150 | 大致说明如下:
151 |
152 | - `holidays`:节假日,这一天将会被记为假期,不统计在剩余时间中;
153 | - `workdays`:工作日,这一天将会被记为工作日,即使是周六或周日;
154 | - 值均为`yyyy-MM-dd`的字符串数组;
155 |
156 | > 请注意计算方式(未在这里列出的情况,可能存在计算问题):
157 | >
158 | > 开始至结束日期间,计算开始日,但不计算结束日,即在结束日当天,将会显示当天(或 还剩0天);(如果结束日为假日,则结束日视为最后一个工作日)
159 | >
160 | > 例1 2024-06-30周日~2024-07-01周一,共1天,0工作日;
161 | >
162 | > 这种情况下,在6月30日便会显示当天,且进度为NaN,这是因为6月30日并不是工作日,则时间段总工作日为0,计算进度百分比时,将出现除以0的情况;
163 | >
164 | > 在已经超过截止日期的情况下,超过x天的计算方式如下:时间段内最后一个工作日至当前时间的全部天数(含假日);
165 | >
166 | > 例2 2024-07-04周四~2024-07-08周一,共4天,2工作日;
167 | >
168 | > 在这种情况下,周四显示“还有2天”,周五显示“还有1天”,周六日一均会显示当天(因为到截止日,已无工作日);
169 |
170 | #### 隐藏进度百分比
171 |
172 | 开发者不推荐隐藏进度百分比,因为这未经过测试,且隐藏后不能向用户反馈保存情况;
173 |
174 | 若要隐藏,可使用css自行实现,隐藏后,可以使用`Ctrl+I`打开关闭设置界面,使用`F5`刷新/保存进度;
175 |
176 |
177 | ## ⚠️注意
178 |
179 | > 由于开发者能力有限,挂件还存在一些问题。
180 |
181 | - 理论上,自动模式通过页面直接计算任务进度,但有些情况将切换为API统计,需手动点击刷新按钮更新进度。例如:
182 | - 任务列表和进度条不在同一页面;
183 | - 任务列表和进度条相距较远;
184 | - 因为挂件未更新而在新版本失效;
185 | - 没有设置界面,需要自行设定挂件属性;
186 | - 任务完成/取消完成勾选的变动,通过MutationObserver获取对应任务节点的class属性变化实现,频繁高亮、选中任务列表块可能导致卡顿;
187 | - 关于`7alltask`统计子任务功能:
188 | - 上一层级任务(父任务)完成,其下子任务不会被认为完成,父任务、子任务统计时权重相同;
189 | - 在进行大量任务节点增删时,会反复触发MutaionObserver(节点变动监视)重设,可能导致卡顿;
190 |
191 | ## 反馈bug
192 |
193 | (推荐)请到github仓库[新建issue](https://github.com/OpaqueGlass/progressBarT-sywidget/issues/new);
194 |
195 | 如您无法访问github仓库,请[点击这里填写问卷](https://wj.qq.com/s2/12395364/b69f/)。
196 |
197 | ## 参考&感谢
198 |
199 | 开发过程中参考了以下网络博客:
200 |
201 | | 博客原文-作者 | 备注 |
202 | | ------------------------------------------------------------ | -------------- |
203 | | https://blog.csdn.net/m0_47214030/article/details/117911609 作者:[☆*往事随風*☆](https://blog.csdn.net/m0_47214030) | 进度条鼠标拖拽 |
204 |
205 | 开发过程中参考了以下大佬的项目:
206 |
207 | | github仓库 / 开发者 | 开源协议 | 备注 |
208 | | ----------------| --------| --------------|
209 | | [widget-query](https://github.com/Zuoqiu-Yingyi/widget-query) / [Zuoqiu-Yingyi](https://github.com/Zuoqiu-Yingyi) | AGPL-3.0 | 从custom.js导入自定义设置 |
210 |
211 |
212 |
213 | ### 依赖
214 |
215 | 1. [jQuery](https://jquery.com/) (本项目中通过jQuery选择页面元素);
216 |
217 | ```
218 | jQuery JavaScript Library v3.6.0 https://jquery.com/
219 | Copyright OpenJS Foundation and other contributors
220 | Released under the MIT license https://jquery.org/license
221 | ```
222 |
223 | 2. jsColor
224 |
225 | 开源协议:[GNU GPL v3](http://www.gnu.org/licenses/gpl-3.0.txt)
226 |
227 | 官方网站:[https://jscolor.com/download/](https://jscolor.com/download/)
228 |
229 | 3. [layDate](http://www.layui.com/laydate/)
230 |
231 | ```
232 | http://www.layui.com/laydate/
233 | https://github.com/layui/laydate
234 | MIT license
235 | ```
236 |
237 |
238 |
239 | ### 图标
240 |
241 | 1. [刷新按钮图标](https://www.iconfinder.com/icons/5402417/refresh_rotate_sync_update_reload_repeat_icon),作者:[amoghdesign](https://www.iconfinder.com/amoghdesign),许可协议:[CC3.0 BY-NC](http://creativecommons.org/licenses/by-nc/3.0/);
242 |
243 | 2. [设置按钮图标](https://www.iconfinder.com/icons/5925600/control_options_settings_icon),作者:[IconPai](https://www.iconfinder.com/iconpai),许可说明:Free for commercial use (Include link to authors website);
244 |
245 |
246 |
247 | [^1]: 计算默认使用DOM统计任务列表进度、配合MutationObserver在任务列表变化时触发重新统计,但在一些条件下无法使用,详见“注意”一节;
248 |
--------------------------------------------------------------------------------
/README_en_US.md:
--------------------------------------------------------------------------------
1 | ## progress Bar T
2 |
3 | > This document was translated by Google Translate.
4 | >
5 | > Note that some text (such as date) is not internationalized.
6 |
7 | > Siyuan note widget showing the progress bar.
8 |
9 | - "Automatic" mode: bind the task list and calculate the completion progress; [^1]
10 | - Manual mode: drag/click to set the progress;
11 | - Time mode: display the progress of the time period;
12 |
13 | ## Quick start (At least read this section)
14 |
15 | - operation:
16 | - Double-click the text on the right side of the progress bar: show or hide settings;
17 | - Automatic mode can only count the list next to the widget or the list set manually;
18 | - (When hiding the text on the right side of the progress bar, please click the text showing the progress percentage);
19 |
20 | 
21 |
22 | - Tips for successful operation:
23 | - When successfully refreshed, the progress percentage will be overlined;
24 | - When saving successfully, the progress percentage will be underlined;
25 | - modes:
26 | - Click the text on the right side of the progress bar: Refresh/Save in manual mode;
27 | - When manually entering the date in the time mode, it is necessary to meet the condition of "year, month, day, hour and minute separated by non-numeric characters", for example: `2023-1-1`, `23:23`;
28 | - other:
29 | - When the document is opened, the widget changes from long to short, which affects the experience? Click the "Reset Widget Height" button or manually drag and drop to save the height;
30 |
31 | > It is strongly recommended to read this document in its entirety;
32 |
33 | ## Setup & Usage
34 |
35 | ### Mode Description
36 |
37 | #### Automatic Mode
38 |
39 | By default (when the task list block id is empty), the widget will automatically get the **task list block immediately below and calculate its progress. (If there is no task list block below, get the task list block immediately above the widget)
40 |
41 | > (Optional, only necessary in the case of pop-up windows, etc.) Using the padding icon on the left, you can quickly fill in the adjacent task list block IDs.
42 |
43 | You can also copy an existing task list block id (not a list item block) to Settings->Task List block id, click the "Save Settings" button to apply the changes in the widget.
44 |
45 | 
46 |
47 | 
48 |
49 | In automatic mode, double-click the `Fn` button (you need to open the settings to see it): cancel/complete **all** task list items corresponding to the block id.
50 |
51 | > When the mouse hovers on the refresh button, when there is `(API)` marked, it cannot be automatically refreshed after modifying the task list block, and you need to manually click the refresh button to calculate the progress.
52 |
53 | #### Manual mode
54 |
55 | Click the corresponding position of the progress bar to set the progress, and then click the refresh button to save the progress. By default, it will be automatically saved 0.5 seconds after the manual change.
56 |
57 | An underline appears under the progress percentage and then disappears, indicating that the settings have been successfully saved. Please confirm that the save is successful before closing the document.
58 |
59 | #### Time Mode
60 |
61 | Set the start time, end time, and click the "Save Settings" button.
62 |
63 | **The time string format accepted by the widget** is: (year, month, day, hour, and minute need to be separated by any non-numeric characters, and the hour is in 24-hour format)
64 |
65 | - `yyyy MM dd` (year month day), such as `2020.1.1` `2020.1.1`
66 | - `yyyy MM dd HH mm` (year month day hour minute), for example `2020.1.1 12.20`
67 | - `HH mm` (will be automatically completed when calculating the progress as the corresponding time of the widget running day, used to display the progress of the day), such as `12.20` `12:20`
68 |
69 | > If it is 20xx, only the last two digits of the year number can be written.
70 |
71 | Please note: In the time mode, the progress refresh frequency is set by `config.js` (please refer to the custom settings), and the default is to refresh once every 10 minutes;
72 |
73 |
74 | ### Custom settings
75 |
76 | Open `${Siyuan data directory}/widgets/progressBarT/static/progressbar.css` to edit the display style of the progress bar, for example:
77 |
78 | - ~~ The default color of the progress bar; ~~ Please note that the color setting of the progress bar is migrated to the config.js setting;
79 | - button styles, etc.;
80 |
81 | #### Changing settings directly in `config.js`
82 |
83 | Open `${Siyuan data directory}/widgets/progressBarT/src/config.js` for custom settings, please refer to the description next to the setting items. Here are some settings that may be commonly used:
84 |
85 | - Automatic save delay `saveAttrTimeout` after manual mode operation;
86 | - Automatic calculation interval `refreshInterval` when API statistics in automatic mode;
87 | - Custom widget attribute names `manualAttrName`, `autoTargetAttrName`, `startTimeAttrName`, `endTimeAttrName`, etc.;
88 | - automatic mode: create block `createBlock` if block does not exist;
89 | - Time mode: timed refresh interval `timeModeRefreshInterval`;
90 | - Show refresh and set button `showButtons` to the right of the progress bar;
91 |
92 | #### Override settings in `custom.js`
93 |
94 | > During testing, there may be bugs.
95 |
96 | Create or edit `${Siyuan data directory}/widgets/custom.js`, only support the setting items under defaultAttr (the default setting when creating widgets) and setting (global settings) in the `config.js` file, the following is a example.
97 |
98 | ```javascript
99 | /*Scheme 1: If there is config before, you need to add the part of progressBarT*/
100 | export const config = {
101 | token: "",
102 | progressBarT:{/*If there is config before, only add the part of progressBarT*/
103 | setting: { // corresponds to setting in config.js
104 | showButtons: true
105 | },
106 | defaultAttr: {// corresponds to defaultAttr in config.js
107 | frontColor: "rgba(255, 255, 255, 1)", // change the front color
108 | barWidth: 12, // progress bar width
109 | frontColorSelector: {//Foreground color color selector configuration (jscolor), if such a complex setting item is changed, all attributes must be re-customized, not only some attributes
110 | value: 'rgba(51,153,255,0.5)',
111 | position: 'bottom',
112 | height: 80,
113 | backgroundColor: '#333',
114 | palette: 'rgba(0,0,0,0) #2da44eff #f1993eff #0080cfff #cb406cff #ff5454ff #af481bff #269affff',//preset color group
115 | paletteCols: 11,
116 | hideOnPaletteClick: true
117 | },
118 | }
119 | }
120 | /*...custom settings for other widgets*/
121 | };
122 | ```
123 |
124 | ```javascript
125 | /*Scheme 2 configure export separately*/
126 | export const progressBarT = {
127 | setting: { // corresponds to setting in config.js
128 | showButtons: true
129 | },
130 | defaultAttr: {// corresponds to defaultAttr in config.js
131 | frontColor: "rgba(255, 255, 255, 1)", // change the front color
132 | barWidth: 12 //Progress bar width
133 | }
134 | }
135 | ```
136 |
137 | #### Holiday Information (Only Workdays )
138 |
139 | In version v0.2.0, we are happy to introduce the "Only Workday" feature to automatically ignore weekends while calculating remaining days.
140 |
141 | If you need to use holiday information in your region, please create `${Work space}/data/storage/progressBarT/holiday.json` and refer to the format in `./static/holiday.json`.
142 |
143 | Briefly:
144 |
145 | - `holidays`: These days will not count in 'Remaining days';
146 | - `workdays`: These days will count in 'Remaining days' even if they are weekends;
147 |
148 | Values should be an array of strings with the date format `yyyy-MM-dd`.
149 |
150 |
151 | #### Hide Progress Percentage
152 |
153 | Developers do not recommend hiding the progress percentage as this has not been tested and, once hidden, it cannot provide feedback to the user about the saving status.
154 |
155 | If you wish to hide it, you can achieve this using CSS. After hiding, you can use Ctrl+I to open and close the settings interface, and use F5 to refresh/save progress.
156 |
157 | ## ⚠️ Note
158 |
159 | > Due to the limited ability of developers, there are still some problems in the widget.
160 |
161 | - In theory, the automatic mode calculates the task progress directly through the page, but in some cases, it will switch to API statistics, and you need to manually click the refresh button to update the progress. For example:
162 | - Task list and progress bar are not on the same page;
163 | - The task list and the progress bar are far apart;
164 | - Invalid in the new version because the widget has not been updated;
165 | - There is no setting interface, you need to set the widget properties by yourself;
166 | - The change of task completion/cancellation is achieved by obtaining the change of the class attribute of the corresponding task node through MutationObserver. Frequent highlighting and selection of task list blocks may cause freezes;
167 | - About `7alltask` statistical subtask function:
168 | - When the task of the previous level (parent task) is completed, the sub-tasks below it will not be considered as completed, and the weight of the parent task and sub-tasks is the same when counting;
169 | - When a large number of task nodes are added or deleted, the MutaionObserver (node change monitoring) reset will be triggered repeatedly, which may cause freezes;
170 |
171 | ## Feedback bugs
172 |
173 | Please go to the github repository and [create a new issue](https://github.com/OpaqueGlass/progressBarT-sywidget/issues/new);
174 |
175 | ## References & Thanks
176 |
177 | The following web blogs were referenced during the development process:
178 |
179 | | Original Blog - Author | Remarks |
180 | | -------------------------------------------------- ----------- | -------------- |
181 | | https://blog.csdn.net/m0_47214030/article/details/117911609 Author: [☆*The past follows the wind*☆](https://blog.csdn.net/m0_47214030) | Progress bar mouse drag |
182 |
183 | During the development process, the following projects (created by awesome developer) were referred to:
184 |
185 | | github warehouse / developer | Open source agreement | Remarks |
186 | | ----------------| --------| --------------|
187 | | [widget-query](https://github.com/Zuoqiu-Yingyi/widget-query) / [Zuoqiu-Yingyi](https://github.com/Zuoqiu-Yingyi) | AGPL-3.0 | From custom. js import custom settings |
188 |
189 |
190 |
191 | ### Dependencies
192 |
193 | 1. jQuery (select page elements through jQuery in this project);
194 |
195 | ```
196 | jQuery JavaScript Library v3.6.0 https://jquery.com/
197 | Copyright OpenJS Foundation and other contributors
198 | Released under the MIT license https://jquery.org/license
199 | ```
200 |
201 | 2. jsColor
202 |
203 | Open source license: [GNU GPL v3](http://www.gnu.org/licenses/gpl-3.0.txt)
204 |
205 | Official website: [https://jscolor.com/download/](https://jscolor.com/download/)
206 |
207 | 3. [layDate](http://www.layui.com/laydate/)
208 |
209 | ```
210 | http://www.layui.com/laydate/
211 | https://github.com/layui/laydate
212 | MIT license
213 | ```
214 |
215 | ### icon
216 |
217 | 1. [Refresh button icon](https://www.iconfinder.com/icons/5402417/refresh_rotate_sync_update_reload_repeat_icon), author: [amoghdesign](https://www.iconfinder.com/amoghdesign), license agreement: [CC3. 0 BY-NC](http://creativecommons.org/licenses/by-nc/3.0/);
218 |
219 | 2. [Settings button icon](https://www.iconfinder.com/icons/5925600/control_options_settings_icon), author: [IconPai](https://www.iconfinder.com/iconpai), license description: Free for commercial use (Include link to authors website);
220 |
221 |
222 |
223 | [^1]: The calculation uses DOM to count the progress of the task list by default, and cooperates with MutationObserver to trigger re-statistics when the task list changes, but it cannot be used under some conditions, see the "Note" section for details;
--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/OpaqueGlass/progressBarT-sywidget/29b19d6e42ad288a8e046c3601804dafd0471719/icon.png
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | progress bar for sy
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |