Mantis Issue Tracking for Scribus
· Hosting provided by Anduin.net / Øverby Consulting ·

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0007812ScribusInternalpublic2009-02-21 20:062014-10-25 01:00
Reporterivro 
Assigned To 
PrioritynormalSeveritytweakReproducibilityN/A
StatusacknowledgedResolutionopen 
PlatformOSOS Version
Product Version1.3.5svn 
Target Version1.5.1Fixed in Version 
Summary0007812: [PATCH] Some source documentation patches
DescriptionHello,

I would like to use Scribus to make book with vertical layout. I find that
scribus can't handle this (yet). As I have some scales in programming, I said
to myself why not doing it.

I start by trying to modify the code to allow scribus to accept vertical
layout, but I stop in the mood as I find difficult to understand all the code
usage (especially variable).
I revert all my changes and start to look deep into the code. In my trip, I
slowly understand more and more about scribus internal, and to remember to
myself what I've find I write some code documentation.

Are you interested by this kind of contributions ?
If yes can you give me some feedback ?

I'm a French so my English is not perfect, but I'll like to correct it. I've
add some questions in the code (look at the comments starting by //ivro:) I
will be pleased If you find time to answer them.

Do you prefer Javadoc or Qt style documentation marks ?
For now, I use Qt style with autobrief mode. (I find it more readable for one variable - one line description, mostly). Are you okay with this ?


You can contact me at ivro@ymail.fr or ivro on freenode.

Bye
TagsNo tags attached.
PatchYes
Attached Files? file icon scribusdoc.h [^] (55,998 bytes) 2009-02-21 20:06
? file icon page.h [^] (5,881 bytes) 2009-02-22 07:49
? file icon diff scribusdoc.h [^] (79,432 bytes) 2009-02-22 22:23
? file icon diff page.h [^] (5,455 bytes) 2009-02-22 22:23
gz file icon docs-patchs-from-ivro-based-on-r13346.tar.gz [^] (45,216 bytes) 2009-03-27 16:07
diff file icon patches-docs-from-ivro-based-on-r13556.diff [^] (84,689 bytes) 2009-03-27 16:44 [Show Content]
gz file icon docs-patches-based-on-r13356.tar.gz [^] (42,653 bytes) 2009-03-27 21:06
? file icon remove-git-patch-header-and-footer.sed-script [^] (61 bytes) 2009-03-27 21:16
patch file icon docs-patches-part1.patch [^] (57,761 bytes) 2009-03-28 02:16 [Show Content]
patch file icon docs-patches-based-on-r13358.patch [^] (87,912 bytes) 2009-03-28 08:56 [Show Content]
patch file icon units-docs-patches-based-on-r13358.patch [^] (17,551 bytes) 2009-03-28 09:10 [Show Content]

- Relationships

-  Notes
(0021182)
cbradney (administrator)
2009-02-21 21:52

Sure, we would love such contributions. We use doxygen to parse the files into http://docs.scribus.net/devel/, [^] so the format existing in some files is ok.
(0021183)
ivro (reporter)
2009-02-21 22:35

Are you ok with the change in scribus.h ?
Do you what a diff ?
(0021184)
ivro (reporter)
2009-02-21 22:44

It's Do you want a diff !
(0021185)
avox (administrator)
2009-02-21 23:51

What do you mean with "vertical layout"? As in Japanese or traditional Chinese writing?
(0021187)
ivro (reporter)
2009-02-22 07:23

No, I mean vertical document. A top and a bottom pages document, like left and right.

######### #########
# # # #
# page 1 # # page 3 #
######### #########
# # # #
# page 2 # # ... #
#########
(0021188)
ivro (reporter)
2009-02-22 07:50

I add more work, see page.h
(0021190)
pierremarchand (reporter)
2009-02-22 12:37

ivro, please upload diffs rather than source files. We need to review your changes and it’s not possible with source files.
TIA
(0021193)
ivro (reporter)
2009-02-22 22:24

Add them.
(0021194)
cbradney (administrator)
2009-02-22 22:51

I'm not clear on the syntax change and how that will affect the doxygen output on docs.scribus.net/devel
(0021195)
ivro (reporter)
2009-02-22 23:19

All the old syntax behave the same. When you explicitly use @brief the behaviour is the same.
The thing that change is when you write a comment without the tag, the first phrase (until the first point) is used as brief. I find it more readable but I can revert things.
(0021196)
cbradney (administrator)
2009-02-22 23:31

The new syntax can stay if it will still work
(0021311)
christoph_s (administrator)
2009-03-15 02:47

Ivro: It would be great if you could complete your work (at least partially) once 1.3.5 is released, i.e. in 1.3.6svn. Thank you very much for your efforts!
(0021324)
cbradney (administrator)
2009-03-15 22:50

ivro, we can include this in 135svn if we have updated files to match current svn ( i mean for easy patching, rather than more completeness)
(0021416)
ivro (reporter)
2009-03-27 11:20

Cool

How can I send it to you ?

My works are on a git repository, set up with full copy of the scribus svn history.
It's available at http://github.com/ivro/scribus/, [^] looks at branch docs.

I can rebase my works on top of any svn revision as you like.
(0021420)
ivro (reporter)
2009-03-27 16:53
edited on: 2009-03-27 17:16

Add diff between r13356 and docs branch

I haven't find a way to create collection of diff in git,
so I sent a full diff on my works.

If you know a way to create diff for each commit in git, you're welcome !

(0021424)
ivro (reporter)
2009-03-27 21:21

I find it!


The file docs-patches-based-on-r13356.tar.gz contains documentations patches based on top of revision 13356.

The file remove-git-patch-header-and-footer.sed-script is a sed script to use git format-patch to generate patch series.
(0021425)
cbradney (administrator)
2009-03-27 21:53

something is wrong with the scribusdoc.h files.. I now have duplicated selection based functions.. any chance u can just make one big patch file?
(0021427)
ivro (reporter)
2009-03-28 00:23

This file patches-docs-from-ivro-based-on-r13556.diff is one
(0021428)
cbradney (administrator)
2009-03-28 00:47
edited on: 2009-03-28 00:47

Something isnt quite right in the file:

- */
- void allItems_ChangePreviewResolution(int id);
 
+<<<<<<< HEAD:Scribus/scribus/scribusdoc.h
+<<<<<<< HEAD:Scribus/scribus/scribusdoc.h
     void itemSelection_ClearItem(Selection* customSelection=0);
     //! Delete the items in the current selection. When force is true, we do not warn the user and make SE happy too. Force is used from @sa Page::restorePageItemCreation
     void itemSelection_DeleteItem(Selection* customSelection=0, bool forceDeletion=false);
@@ -1203,10 +1836,44 @@ public slots:
     void undoRedoBegin();
     void undoRedoDone();
 
+=======
+>>>>>>> Documents ScribusDoc itemSelection related:Scribus/scribus/scribusdoc.h
     void updatePic();
     void updatePict(QString name);
     void updatePictDir(QString name);
     void removePict(QString name);
+
+=======
+>>>>>>> Groups and documents ScribusDoc various related:Scribus/scribus/scribusdoc.h

(0021429)
ivro (reporter)
2009-03-28 02:17

docs-patches-part1.patch -> the valid part of patches
(0021430)
ivro (reporter)
2009-03-28 08:57

docs-patches-based-on-r13358.patch is the corrected patch
(0021431)
ivro (reporter)
2009-03-28 09:12

units-docs-patches-based-on-r13358.patch documents units functions.

It renames the argument index to unit.
(0032433)
Kunda (manager)
2014-07-03 16:26

bumping to 1.5.1 (patch is 5 years old and most likely needs re-tweaking)
(0032934)
Kunda (manager)
2014-07-23 23:38

ivro, If this email is still active. Please respond give a heads up if you are still interested in helping in your efforts here. Appreciate the work you did.
(0033743)
Kunda (manager)
2014-09-18 23:17

Cannot reach OP through email and he hasn't responded to this thread. Is there anything we can salvage from these patches ?

- Issue History
Date Modified Username Field Change
2009-02-21 20:06 ivro New Issue
2009-02-21 20:06 ivro File Added: scribusdoc.h
2009-02-21 21:52 cbradney Note Added: 0021182
2009-02-21 22:35 ivro Note Added: 0021183
2009-02-21 22:44 ivro Note Added: 0021184
2009-02-21 23:51 avox Note Added: 0021185
2009-02-22 07:23 ivro Note Added: 0021187
2009-02-22 07:49 ivro File Added: page.h
2009-02-22 07:50 ivro Note Added: 0021188
2009-02-22 12:37 pierremarchand Note Added: 0021190
2009-02-22 22:23 ivro File Added: diff scribusdoc.h
2009-02-22 22:23 ivro File Added: diff page.h
2009-02-22 22:24 ivro Note Added: 0021193
2009-02-22 22:51 cbradney Note Added: 0021194
2009-02-22 23:19 ivro Note Added: 0021195
2009-02-22 23:31 cbradney Note Added: 0021196
2009-03-15 02:45 christoph_s Status new => acknowledged
2009-03-15 02:46 christoph_s Target Version => 1.3.6
2009-03-15 02:47 christoph_s Note Added: 0021311
2009-03-15 22:50 cbradney Note Added: 0021324
2009-03-27 11:20 ivro Note Added: 0021416
2009-03-27 16:07 ivro File Added: docs-patchs-from-ivro-based-on-r13346.tar.gz
2009-03-27 16:08 ivro Note Added: 0021419
2009-03-27 16:44 ivro File Added: patches-docs-from-ivro-based-on-r13556.diff
2009-03-27 16:53 ivro Note Added: 0021420
2009-03-27 17:16 ivro Note Deleted: 0021419
2009-03-27 17:16 ivro Note Edited: 0021420
2009-03-27 21:06 ivro File Added: docs-patches-based-on-r13356.tar.gz
2009-03-27 21:16 ivro File Added: remove-git-patch-header-and-footer.sed-script
2009-03-27 21:21 ivro Note Added: 0021424
2009-03-27 21:53 cbradney Note Added: 0021425
2009-03-28 00:23 ivro Note Added: 0021427
2009-03-28 00:47 cbradney Note Added: 0021428
2009-03-28 00:47 cbradney Note Edited: 0021428
2009-03-28 02:16 ivro File Added: docs-patches-part1.patch
2009-03-28 02:17 ivro Note Added: 0021429
2009-03-28 08:56 ivro File Added: docs-patches-based-on-r13358.patch
2009-03-28 08:57 ivro Note Added: 0021430
2009-03-28 09:10 ivro File Added: units-docs-patches-based-on-r13358.patch
2009-03-28 09:12 ivro Note Added: 0021431
2014-07-03 16:26 Kunda Note Added: 0032433
2014-07-03 16:26 Kunda Target Version 1.5.0 => 1.5.1
2014-07-23 23:38 Kunda Note Added: 0032934
2014-07-23 23:38 Kunda Summary Some souce documentation => [PATCH] Some source documentation patches
2014-09-18 23:17 Kunda Note Added: 0033743
2014-10-25 00:57 Kunda Patch => Yes



Copyright © 2000 - 2014 MantisBT Team
Powered by Mantis Bugtracker